Skip to content

Commit

Permalink
docs: add newlines to cmake command (#5411)
Browse files Browse the repository at this point in the history
  • Loading branch information
scarf005 authored Sep 24, 2024
1 parent 81ef0ab commit 38441b0
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions doc/src/content/docs/en/dev/guides/building/atomic_cmake.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ the desired solution rather than layering the dependencies onto your base instal

# Example: Fedora Atomic-based (Bazzite)

Note: This section is based off of the process taken to help another contributor build on Bazzite

:::caution

As of writing this, Bazzite's default container image is fedora-toolbox:38, which results in having
Expand Down Expand Up @@ -75,7 +73,30 @@ worry about creating the build folder yourself, cmake will automatically generat
present already) For Bazzite, this looks like:

```sh
cmake -B build -G Ninja -DCATA_CCACHE=ON -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_INSTALL_PREFIX=$HOME/.local/share -DJSON_FORMAT=ON -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCURSES=OFF -DTILES=ON -DSOUND=ON -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DCATA_CLANG_TIDY_PLUGIN=OFF -DLUA=ON -DBACKTRACE=ON -DLINKER=mold -DUSE_XDG_DIR=ON -DUSE_HOME_DIR=OFF -DUSE_PREFIX_DATA_DIR=OFF -DUSE_TRACY=ON -DTRACY_VERSION=master -DTRACY_ON_DEMAND=ON -DTRACY_ONLY_IPV4=ON
cmake \
-B build \
-G Ninja \
-DCATA_CCACHE=ON \
-DCMAKE_C_COMPILER=clang \
-DCMAKE_CXX_COMPILER=clang++ \
-DCMAKE_INSTALL_PREFIX=$HOME/.local/share \
-DJSON_FORMAT=ON \
-DCMAKE_BUILD_TYPE=RelWithDebInfo \
-DCURSES=OFF \
-DTILES=ON \
-DSOUND=ON \
-DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
-DCATA_CLANG_TIDY_PLUGIN=OFF \
-DLUA=ON \
-DBACKTRACE=ON \
-DLINKER=mold \
-DUSE_XDG_DIR=ON \
-DUSE_HOME_DIR=OFF \
-DUSE_PREFIX_DATA_DIR=OFF \
-DUSE_TRACY=ON \
-DTRACY_VERSION=master \
-DTRACY_ON_DEMAND=ON \
-DTRACY_ONLY_IPV4=ON
```

Assuming all goes well, you should now have your CMake files generated! Now, all you need to do is
Expand Down

0 comments on commit 38441b0

Please sign in to comment.