builddir to build

lanl · Oct 30, 2024 · a1440fc · a1440fc
1 parent e87446d
commit a1440fc
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/doc/sphinx/src/getting-started.rst b/doc/sphinx/src/getting-started.rst
@@ -10,8 +10,8 @@ At it's most basic, you can download and compile ``singularity-eos`` with:
   git clone --recursive [email protected]:lanl/singularity-eos.git
   cd singularity-eos
   cmake -B builddir -S . -DSINGULARITY_FORCE_SUBMODULE_MODE=ON -DSINGULARITY_USE_FORTRAN=OFF -DSINGULARITY_BUILD_EXAMPLES=ON -DSINGULARITY_BUILD_TESTS=ON 
-  cmake --build builddir --parallel
-  cmake --install builddir # optional: install into directory defined via CMAKE_INSTALL_PREFIX
+  cmake --build build --parallel
+  cmake --install build # optional: install into directory defined via CMAKE_INSTALL_PREFIX
 
 This will download ``singularity-eos`` with no optional dependencies and
 compile the capabilities available in that form. For more details, see
@@ -23,7 +23,8 @@ You can also run unit tests by calling
 
   make test
 
-which should produce output confirming that several tests pass.
+in the ``build`` directory, which should produce output confirming that
+several tests pass.
 
 Once compiled, you can quickly check your build/install by going to
 ``build/example`` and running ``./get_sound_speed_press``. You should be