DOC: Installation instructions lead to "hello, world"

lnx-search / lnx

⚡ Insanely fast, 🌟 Feature-rich searching. lnx is the adaptable, typo tollerant deployment of the tantivy search engine.

https://lnx.rs

MIT License

1.23k stars 46 forks source link

DOC: Installation instructions lead to "hello, world" #130

Open remram44 opened 1 year ago

remram44 commented 1 year ago

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.

ChillFish8 commented 1 year ago

Ah yes, we should update the docs, it's probably best to checkout a specific tag lining up with the version of the docs.

aliceylan commented 9 months ago

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