Skip to content

Update README.md to add quickstart section #554

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 4 commits into
base: s6/docs_update
Choose a base branch
from

Conversation

jwinpbe
Copy link

@jwinpbe jwinpbe commented Jun 25, 2025

add quickstart section using ubergarm's discussion post. Scrolling to the discussion every time I want to remember how to build the damn thing is a minor inconvienience so this pull request is both useful and self-serving. Thanks <3

jwinpbe added 3 commits June 25, 2025 03:20
add quickstart section
used the master branch's readme this time because i'm silly
@saood06
Copy link
Collaborator

saood06 commented Jun 25, 2025

The quickstart section seems like a very oversimplified version of the docs/build.md file (which I just noticed should be updated to reference ik_llama.cpp not llama.cpp.

I do think a Quick Start section similar to mainline could be beneficial but I still think it should go after the News section (which still needs to be shorter), and reference docs/build.md.

@jwinpbe
Copy link
Author

jwinpbe commented Jun 25, 2025

I'll happily defer to your judgement -- I see you updating documents all the time. I don't want to iterate over the news section as I don't feel like that's my call. Thanks again.

@ikawrakow
Copy link
Owner

Why do I see the latest news as being changed in the diff?

cd ik_llama.cpp

# Configure CUDA+CPU Backend
cmake -B ./build -DGGML_CUDA=ON -DGGML_BLAS=OFF
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-DGGML_BLAS=OFF

Is not needed, it is off by default.

cmake -B ./build -DGGML_CUDA=ON -DGGML_BLAS=OFF

# *or* Configure CPU Only Backend
cmake -B ./build -DGGML_CUDA=OFF -DGGML_BLAS=OFF
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

@saood06
Copy link
Collaborator

saood06 commented Jun 25, 2025

Why do I see the latest news as being changed in the diff?

Because this PR is targeting an old branch, and manually pulled in the changes from main.

@saood06
Copy link
Collaborator

saood06 commented Jun 25, 2025

I don't want to iterate over the news section as I don't feel like that's my call.

I'd be curious about your opinions. I ran out of ideas on how to condense it, and it is also just good to hear the perspective of someone else.

@jwinpbe
Copy link
Author

jwinpbe commented Jun 25, 2025

Why do I see the latest news as being changed in the diff?

i'm hiding the fact that this is a drive by pull request by making it extremely amateurish (read: i am not used to using the github webui and didn't know i could just edit the readme on the main branch and make a new branch from the edit)

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

Successfully merging this pull request may close these issues.

3 participants