Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

doc: Update build from source documentation #1951

Merged
merged 4 commits into from
Feb 11, 2025
Merged

doc: Update build from source documentation #1951

merged 4 commits into from
Feb 11, 2025

Conversation

gau-nernst
Copy link
Contributor

Describe Your Changes

This PR brings back the old Build from source instructions from 9f5a796. To keep the main README clutter-free, it's been put under BUILDING.md

Linux and Macos instructions are combined since they are the same

Fixes Issues

Self Checklist

  • Added relevant comments, esp in complex areas
  • Updated docs (for bug fixes / features)
  • Created issues for follow-up changes or refactoring needed

@gau-nernst gau-nernst changed the title Thien/doc/build [doc] Update build from source documentation Feb 11, 2025
@gau-nernst
Copy link
Contributor Author

When I tried this on my Ubuntu machine, cmake is not available -> I had to run sudo apt install cmake. My Macbook already has cmake from homebrew, hence I didn't encounter this error.

To further improve the doc, perhaps we can't assume that users have cmake installed. Should we add a section on install cmake?

@vansangpfiev
Copy link
Contributor

When I tried this on my Ubuntu machine, cmake is not available -> I had to run sudo apt install cmake. My Macbook already has cmake from homebrew, hence I didn't encounter this error.

To further improve the doc, perhaps we can't assume that users have cmake installed. Should we add a section on install cmake?

Agree, I think we should add a prerequisite section

@gau-nernst gau-nernst changed the title [doc] Update build from source documentation doc: Update build from source documentation Feb 11, 2025
@gau-nernst gau-nernst merged commit 76b1983 into dev Feb 11, 2025
@gau-nernst gau-nernst deleted the thien/doc/build branch February 11, 2025 06:07
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: Build from source instruction does not work
2 participants