Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
remram44 opened this issue Jan 13, 2023 · 2 comments
Open

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

remram44 opened this issue Jan 13, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@remram44
Copy link

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
Copy link
Member

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

@ChillFish8 ChillFish8 added the documentation Improvements or additions to documentation label Jan 13, 2023
@aliceylan
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants