Closed tmozgach closed 6 years ago
@sjackman do you have any templates, platforms, where and what exactly I should write down?
This is a bit different than a normal software package, but you can take a look these: https://github.com/linuxbrew/brew#readme https://github.com/bcgsc/abyss#readme https://github.com/bcgsc/tigmint#readme
Outline:
@sjackman could you look at the scratch plan? Anything else to add? Also I am wondering where should I write down this documentation?
The outline looks good! You can put Introduction, Installation, and Support in the main README.md
. If you find it's getting unwieldy, you can create files in the docs
folder of this repo. Or if you prefer, you could put it all in the docs
folder and create a link to it from the main README.md
.
How to set up Docker, Docker Swarm, create accounts etc.