A short description about the project and/or client.
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.
The things you need before installing the software.
- You need this
- And you need this
- Oh, and don't forget this
A step by step guide that will tell you how to get the development environment up and running.
$ First step
$ Another step
$ Final step
A few examples of useful commands and/or tasks.
$ First example
$ Second example
$ And keep this in mind
Additional notes on how to deploy this on a live or release system. Explaining the most important branches, what pipelines they trigger and how to update the database (if anything special).
- Live:
- Release:
- Development:
- Master:
- Feature:
- Bugfix:
- etc...
- Project folder on server:
- Confluence link:
- Asana board:
- etc...