I’m Listening to This
(song that I’ve sent you an image about detailing its metadata in a nifty way)
Few lines describing your project.
?
About
Write about 1-2 paragraphs describing the purpose of your project.
?
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
What things you need to install the software and how to install them.
Give examples
Installing
A step by step series of examples that tell you how to get a development env running.
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo.
?
Running the tests
Explain how to run the automated tests for this system.
Break down into end to end tests
Explain what these tests test and why
Give an example
And coding style tests
Explain what these tests test and why
Give an example
?
Usage
Add notes about how to use the system.
?
Deployment
Add additional notes about how to deploy this on a live system.
⛏️
Built Using
✍️
Authors
- @UP2014372 – Moderately attractive Developer
- @A9-dev – Sexy Developer
See also the list of contributors who participated in this project.
?
Acknowledgements
- Hat tip to anyone whose code was used
- Inspiration
- References
