Currently all documentation exists in README.md. While this might work OK for now, as more and more steps are added it gets cumbersome to update the docs, and it will become less readable by the end-user. A TL;DR with a list of the available steps should exist in the README, while end-user docs should probably be moved to Read the docs or some similar service.
Currently all documentation exists in README.md. While this might work OK for now, as more and more steps are added it gets cumbersome to update the docs, and it will become less readable by the end-user. A TL;DR with a list of the available steps should exist in the README, while end-user docs should probably be moved to Read the docs or some similar service.