- 📌About The Project
- 🏁Getting Started
- 🎈Usage
- 🎢Roadmap
- 👥Contributing
- 🔑License
- ✏️Authors
- 🎉Acknowledgments
Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor repo_name
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
- numpy
pip install numpy
- Clone the repo
git clone https://github.com/cychitivav/repo_name.git
- Next steps
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
Note: For more examples, please refer to the* Documentation
- Feature 1
- Feature 2
- Nested Feature
Note: See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
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.
- Cite1