-
Notifications
You must be signed in to change notification settings - Fork 12k
docs : add "Quick start" section for new users #13862
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
Conversation
I have never heard of flox before, and from what I can tell it is just using the nix package. Generally I am not sure about promoting packages that we have no control over. |
@slaren have not heard of it before, but it looks to already be present under section "Building the project" in "README.md" and "Flox" in docs/install.md . So I suspect he was just doing a carry over of that section. It's worth however considering if we should delete this term from the repo in a separate pull request. |
Ok, but still, there is a difference between listing a package as the recommended way to use llama.cpp, and as a note at the bottom of |
I don't know about flox either, I think it was added before I joined the project as contributor, so I have no visibility about it. If any nix packages is usable in flox (which seems to be the case), then it will be a common knowledge for flox users to just use whatever nix package that they want. Therefore, I think it's not useful to mention flox here. |
@ggerganov WDYT about removing the guide for |
Let's remove it. I'm also not familiar with it. |
It may be worth adding a recommendation to check out the getting started guide of various bindings. This is the command from the getting started guide: npm create node-llama-cpp@latest |
@giladgd you can include such guide on the downstream github, not in llama.cpp here we only give a list of links to the downstream projects. no one here have time to maintain the commands for all of the 27 binding packages |
@slaren could you confirm if this looks good to you now? |
If you remove the "⭐ Recommended" I would agree with this change, but I cannot recommend packages that I know nothing about. I wouldn't even recommend using winget at the moment, because many people could get better performance by downloading a release of a different backend. |
I added that because in term of UX it's the best way. But OK to remove it as you said, probably we would need to put the explanation you just said somewhere in the doc |
QoL change for new users, add a "Quick start" section on top, so they don't have to scroll through the page to get to the right place.
Another QoL change, I added a table to tell which platform uses which package manager: