-
Notifications
You must be signed in to change notification settings - Fork 65
Docs: update ubuntu example setup for quicker start #1431
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
mgovers
wants to merge
5
commits into
main
Choose a base branch
from
pgm/feature/update-ubuntu-build-guide
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+18
−19
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a20ba44
update ubuntu example setup for quicker start
mgovers 8dfb72b
resolve comments
mgovers 5f5dcb0
Apply suggestion from @mgovers
mgovers 6f31db4
ubuntu 24.04, gcc (++) 14
figueroa1395 d376da8
Merge branch 'main' into pgm/feature/update-ubuntu-build-guide
figueroa1395 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -235,39 +235,39 @@ To list the available presets, run `./build.sh -h`. | |
| In this section an example is given for setup in Ubuntu 24.04. | ||
| You can use this example in Windows Subsystem for Linux (WSL), or in a physical/virtual machine. | ||
|
|
||
| ### Ubuntu Software Packages | ||
| While you can use `apt`, setup via [Homebrew](https://brew.sh) has proved to be much simpler. | ||
| In addition, the recommended way to get the [C++ packages](#c) and `uv` is via [Homebrew](https://brew.sh). | ||
|
|
||
| Install the minimum required packages: | ||
| ### Set-up Homebrew | ||
|
|
||
| ```shell | ||
| sudo apt update && sudo apt -y upgrade | ||
| sudo apt install -y build-essential gcc g++ clang-18 make ninja-build pkg-config | ||
| ``` | ||
| Follow the setup guidelines in [Homebrew](https://brew.sh). | ||
| For optimal user experience on Linux, also consider installing the | ||
| [requirements](https://docs.brew.sh/Homebrew-on-Linux#requirements) as well. | ||
|
|
||
| The following packages are optional depending on your use case: | ||
| At the time of writing, the set-up is done as follows: | ||
|
|
||
| ```shell | ||
| sudo apt install -y gcovr lcov # For coverage reports | ||
| sudo apt install -y gdb # For debugging | ||
| sudo apt install -y wget curl zip unzip tar git # General use tools | ||
| sudo apt update && sudo apt -y upgrade # make sure you're up to date | ||
| sudo apt install build-essential gcc g++ clang-18 procps curl file git # install initial dependencies | ||
| ``` | ||
|
|
||
| ### C++ Dependencies for CMake | ||
| Then install Homebrew using the setup recommendations in [Homebrew](https://brew.sh). | ||
|
|
||
| ### C++ Dependencies + Build Requirements | ||
|
|
||
| The recommended way to get the [C++ packages](#c) and `uv` is via [Homebrew](https://brew.sh): | ||
|
|
||
| ```shell | ||
| brew install boost eigen nlohmann-json msgpack-cxx doctest cmake uv | ||
| brew install \ | ||
| gdb gcovr lcov lld cmake ninja \ | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i am not sure how it works if |
||
| boost eigen nlohmann-json msgpack-cxx doctest uv | ||
| ``` | ||
|
|
||
| ### Environment variables | ||
|
|
||
| Append the following lines into the file `${HOME}/.bashrc`. | ||
| Append the following lines into the file `${HOME}/.bashrc` (required for `scikit-build` for the Python installation): | ||
|
|
||
| ```shell | ||
| export CXX=clang++-18 # or g++-14 | ||
| export CC=clang-18 # or gcc-14 | ||
|
figueroa1395 marked this conversation as resolved.
|
||
| export CMAKE_PREFIX_PATH=/home/linuxbrew/.linuxbrew # only needed for CMake builds | ||
|
figueroa1395 marked this conversation as resolved.
|
||
| export CXX=clang++ # or g++ or g++-14 or ... | ||
| export CC=clang # or gcc or gcc-14 or ... | ||
| export LLVM_COV=llvm-cov-18 # only if you want to use one of the llvm features | ||
| export CLANG_TIDY=clang-tidy-18 # only if you want to use one of the clang-tidy presets | ||
| ``` | ||
|
|
@@ -458,7 +458,6 @@ As a quick start, from the root of the repository: | |
|
|
||
| ```{note} | ||
| Test coverage is not supported on macOS. | ||
| ``` | ||
|
|
||
| ## Package tests | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.