DOC: Installation instructions lead to "hello, world"
remram44 opened this issue · 2 comments
The first step in your documentation is to git clone and cargo build. However your default branch is lnx-v0.10.0 where the lnx binary does absolutely nothing.
It is not super complicated to figure out what's going on and switch to the master branch, however this is very awkward and a bad first impression. Consider having a default branch that is functional, or updating your documentation.
Ah yes, we should update the docs, it's probably best to checkout a specific tag lining up with the version of the docs.
It was a bit confusing for me that there was no git clone of the stable branch in the stable branch's documentation.
A small update might be helpful
git clone --single-branch --branch 0.9.0 https://github.com/lnx-search/lnx.git