Hello, me again, with another thing relating to the README :)
I think there may be value to add some more specific examples to the README, especially in regards to onboarding/first time use. Just got the software working on my machine, and here are some things that would have made my life easier:
- a guide which release file is the right one for the most common Linux distros
- a full example for the installation progress in Linux, including making the file executable and a ready-made
mvcommand to move it into path - an explanation that
git bug user createin fact pulls in your standard git identity, and you don't have to bother withadoptin the default case - making sure that what you get when you use
--helpon a (sub)command is also what is explained in the README - a heads-up that
identityin the interactive bridge-adding process is just your username, and that you will be guided through optionally the auth key creation if you wish - generally, a full run through the detailed getting-started process of someone downloading and using git-bug for the first time
I hope this is helpful, and please don't take it as criticism. My point is only that adding some more stuff in this direction may help with getting new users smoothly going without snags :)
Anyways, have a good one 👋