This repo is an easy to use template for making a quality README.md. Geared towards educational courses and personal learning projects. See the rest of this README for information on how to use and contribute to the repo.
This project is essentially a storage repo on GitHub so you already have it installed! If you reall wanted to have the entire thing locally on your machine, then:
- Clone the repo
git clone git@github.com:Mateo-Wallace/M9-README-Generator.git
- To use this project simply navigate to the file that most resembles your needs. You can find a list of directories in the Directories tab above.
- Download the file and add it to your project. You can also copy the raw data and paste the sections you need into your own README.md file.
- Edit the contents of the copied README to fit your needs.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (git checkout -b feature/AmazingFeature)
- Commit your Changes (git commit -m 'Add some AmazingFeature')
- Push to the Branch (git push origin feature/AmazingFeature)
- Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
For any further questions feel free to contact me via:
- GitHub: Mateo-Wallace
- Email: mateo.t.wallace@gmail.com
- LinkedIn: Mateo Wallace
Special thanks to these resources. You have proven invaluable to creating this project: