---

PRG Silver Tier Template

What is this Template for? This Template is part of the Personal Repository Guidelines (PRG) repository categorization and guideline framework. Visit the PRG Repository to get started with PRG today. Visit The Official PRG Website for more information. Submit a pull request to add your PRG Portfolio to the PRG Showcase.

Looking for other Tier Templates? Platinum Tier Template Gold Tier Template You are here Silver Tier Template Bronze Tier Template

Note

I will be using examples from my project River Charts for this README.

• The description should be a short paragraph describing what your project is and what it does.
• This should be the first section after the badges.
  • e.g. "A Python, Django, Plotly, and Pandas web application that visualizes river data pulled using an API from the United States Geological Survey (USGS)."
• Add screenshots of your project below the description and throughout the rest of the README as needed.
  • This is optional, but highly recommended especially for Gold projects.
  • Animations in the form of GIFs are also a great way to showcase your project.

Warning

Be sure to remove the .gitattributes file from this repository. It's used to classify this template repository as a Markdown file on GitHub only, and not needed.

---

Table of Contents

• Getting Started
  • Dependencies
  • Configuration
  • Installation
  • Deployment
• Specific Project Sections
• Resources
• License -MIT -GNU -The Unlicense
• Credits

Getting Started

This section should contain a list of steps to get your project up and running.

• You can break this section down into further subsections if you want (such as below: Dependencies, Configuration, Running Locally, Deployment, etc.).
• Otherwise, you can just include a list of steps to get your project up and running under Getting Started.

Dependencies

• This section should contain a list of dependencies for your project.

Configuration

• This section should contain a list of steps to configure your project.

Installation

• This section should contain a list of steps to install your project.
• Utilize code blocks to show the commands needed to run your project.
• e.g.
  1. Clone this repository.
  2. Create a virtual environment: python -m venv venv.
  3. Install the dependencies.
  4. Run the application:

     python manage.py runserver

Deployment

• This section should contain a list of steps to deploy your project.

Specific Project Sections

There should be a number of sections here that correspond to important aspects of your project.

• Do not name this section "Specific Project Sections".
• e.g. "API", "Database", "Deployment", "Testing", etc.

Resources

This section should contain a list of resources that you used to create your project.

Below are some external resources I found helpful when creating My Project:

• Python - An interpreted, high-level and general-purpose programming language.
• Plotly - A Python graphing library that makes interactive, publication-quality graphs online.
• Django - A high-level Python Web framework that encourages rapid development and clean, pragmatic design.
• Pandas - A fast, powerful, flexible and easy to use open source data analysis and manipulation tool, built on top of the Python programming language.

License

This section should contain the license for your project. It should include a link to your actual license file inside your repository, and a link to Choose an open source license for reference.

Important

Use the docs/LICENSE/ directory to pick amongst a few popular license files for your project. You can also visit Choose an open source license to pick your own that's not included with this template. If you don't include a LICENSE file, see what happens here. For a zero restriction license, choose The Unlicense.

Warning

Be sure to remove the docs/LICENSE/ directory from this repository when you're done picking your license. Be sure to include your LICENSE file in the root of your repository and change the link below to point towards it.

Examples:

MIT

This project is released under the terms of the MIT License, which permits use, modification, and distribution of the code, subject to the conditions outlined in the license.

• The MIT License provides certain freedoms while preserving rights of attribution to the original creators.
• For more details and to understand all requirements and conditions, see the LICENSE file in this repository.

GNU

This project is released under the terms of the GNU General Public License, version 3 (GNU GPLv3), which ensures that derivatives of the software remain open source.

• The GNU GPLv3 is a "copyleft" license, ensuring that derivatives of the software remain open source and under the GPL.
• For more details and to understand all requirements and conditions, see the LICENSE file in this repository.

The Unlicense

This project is released under the terms of The Unlicense, which allows you to use, modify, and distribute the code as you see fit.

• The Unlicense removes traditional copyright restrictions, giving you the freedom to use the code in any way you choose.
• For more details and to understand all requirements and conditions, see the LICENSE file in this repository.

Credits

Author: Scott Grivner
Email: [email protected]
Website: scottgrivner.dev
Reference: Main Branch

---