A brief description of what this project does and who it's for.
An in-depth paragraph about your project and overview of use.
<<DEPENDENCY_INSTRUCTIONS>>
How/where to download your program. Any modifications needed to be made to files/folders.
<<INSTALL_INSTRUCTIONS>>How to run the program. Step-by-step bullets.
<<EXECUTING_INSTRUCTIONS>>A few motivating and useful examples of how your project can be used. Spice this up with code blocks and potentially more screenshots.
// Use examples
myProject.doSomethingAwesome();Guidelines for how to help with your project. Buy me a coffee?
Link to the Code of Conduct.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
Contributors' names and contact info
- @sith-lords
This project is licensed under the [Your License] License - see the LICENSE.md file for details
Inspiration, code snippets, etc.