This project provides a minimal and meaningful template for README files. Feel free to use it in your repositories. (Project description.)
Status: Completed | Dropped | Actively developed | Occasionally developed | Actively maintained | Occasionally maintained
Type: Academic project | Personal project | Company project
Course: Course name [optional]
Development year(s): XXXX | XXXX+ | XXXX-XXXX
Author(s): user [(optional contribution)], user [(optional contribution)], ...
Notes: notes [optional]
Instructions to get a copy of the project up and running (on a local and/or remote machine) and for development and testing purposes.
command
Instructions to get the required dependencies for the project.
command
Notes about how to install the project.
command
Notes about how to run tests.
command
Notes about how to deploy the project on a live system.
command
- Tool/library/platform - Reason it has been used for
- Tool/library/platform - Reason it has been used for
- ...
This project is not actively maintained and issues or pull requests may be ignored. | Any contribution is welcome. Please read CONTRIBUTING.md for details on how to submit pull requests.
This project is licensed under the X license. Please refer to the LICENSE.md file for details.
This README.md complies with this project template. Feel free to adopt it and reuse it.