rhea-so-archive / good-readme.md-template

📘 This is a pretty simple README.md template. Apply this template to your repository and introduce it to others efficiently.

Title

One Paragraph of the project description

Getting Started • Built With • Roadmap • Community • Contributing • License

Getting Started

Instructions on setting up your project locally
To get a local copy up and running follow these simple steps

Prerequisites

List things you need to use the software

• Example 1
• Example 2

Installation

Run under scripts

git clone <project>
cd <project>

Run

Run under scripts

run <environment>

Test

Run under scripts

test <environment>

Built With

List things used to build the project

• Example 1 - One line of the description
• Example 2 - One line of the description

Roadmap

v1.0.0

• One feature of project and developed
• One feature of project and undeveloped

Note Will be completed on January 1, 2100

Community

List of link that can communicate about project

• Discord
• Slack
• Reddit

Contributing

Please read CONTRIBUTING.md

License

This project is licensed under the MIT