grabbit
grabbit copied to clipboard
TWCable
Create better documentation for the project
As the tool gets more sophisticated, the README is not going to be sufficient.
An alternative is to keep the documentation in the repository (e.g., Markdown/AsciiDoctor in a docs directory) so that it always matches the code at any particular state.
I created a wiki page with basic getting started notes. It was pretty frustrating to figure out those few points on my own.
Hi Mark,
What steps did you have trouble with? Documentation for building Grabbit is in the README under "Building from source." Note, if you are building Grabbit for previous versions, the README build instructions may change accordingly. You would have to view the instructions from what ever release tag. That is at least partly what this ticket would hopefully address.
@ChestersGarage Thank you for adding the wiki page!
If I may ask, why were you building from source instead of simply installing from the pre-built packages on BinTray referenced at the top of the README? Was it because you were adding new functionality, or that it was too easy to not see the link?