Skip to content

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ngxson
Copy link
Collaborator

@ngxson ngxson commented May 28, 2025

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.

image

Another QoL change, I added a table to tell which platform uses which package manager:

image

@ngxson ngxson requested a review from ggerganov May 28, 2025 15:10
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 28, 2025
@ggerganov ggerganov requested a review from slaren May 29, 2025 05:57
@slaren
Copy link
Member

slaren commented May 29, 2025

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.

@mofosyne
Copy link
Collaborator

@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.

@slaren
Copy link
Member

slaren commented May 29, 2025

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 install.md. I think it is ok to give a shout out to other projects, but recommending them should require a different standard. In this case though, I am not sure that we need to mention flox at all, since it seems to be only a different way to install the nix package.

@ngxson
Copy link
Collaborator Author

ngxson commented May 29, 2025

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.

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

Successfully merging this pull request may close these issues.

4 participants