Brief description - this is a Readme template you can reuse on your projects.
Table of Contents: (optional)
If this is a module or component, include a brief usage example here.
If this project has an API (whether it's a REST interface or class interface), mention it here with a link to the API documentation.
A brief list of the major parts used to build / work on the project. Example:
- Vagrant
- MySQL 5.7
- Apache 2.4
- Composer
- Symfony Framework
A short guide to getting up and running with a dev environment. Example follows:
To configure a new environment for dev work using vagrant:
- Install VirtualBox
- Install Vagrant
- Navigate to project directory and run
vagrant up - Web server will be available on localhost:8080
Additional notes and warnings about development.
How to run this project's test, and how to make new tests.
Documentation detailing everything one would need to know to deploy the application to it's production environment. Should not contain credentials - instead note where credentials are securely stored.
- Template written by @brewcore
- N/A
Guidelines for others contributing to the project, such as code style preferences.
If needed, this section can list anyone that majorly contributed to the project.
The project's license and Copyright information should appear here.
Copyright 2017 Industrial Resolution LLC