Project name is a <utility/tool/feature> that allows <insert_target_audience> to do <action/task_it_does>.
Additional line of information text about what the project does. Your introduction should be around 2 or 3 sentences. Don't go overboard, people won't read it.
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of
<coding_language/dependency/requirement_1> - You have a
<Windows/Linux/Mac>machine. State which OS is supported/which is not. - You have read
<guide/link/documentation_related_to_project>.
To install <project_name>, follow these steps:
Linux and macOS:
<install_command>
Windows:
<install_command>
To use <project_name>, follow these steps:
<usage_example>
Add run commands and examples you think users will find useful. Provide an options reference for bonus points!
Add information about what tests are available for the software and how to run them
See our CONTRIBUTING page for details on how to contribute to this project.
Thanks to the following people who have contributed to this project:
All CanDIG code is licensed with LGPL-3.0 license.