Skip to content

Commit

Permalink
doc: Update cmake invocations for cross-platform builds
Browse files Browse the repository at this point in the history
Signed-off-by: Siddharth Chandrasekaran <[email protected]>
  • Loading branch information
sidcha committed Aug 3, 2024
1 parent 40af610 commit f6fb9d0
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 17 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,14 +137,12 @@ that are exposed by libosdp.

```sh
git clone https://github.com/goToMain/libosdp --recurse-submodules
# git submodule update --init (if you missed doing --recurse-submodules earlier)
cd libosdp
mkdir build && cd build
cmake ..
make
cmake -B build .
cmake --build build --parallel
```

Refer to [this document][23] for more information on build and cross
Refer to the [documentation][23] for more information on build and cross
compilation.

### Run the test suite
Expand Down
33 changes: 21 additions & 12 deletions doc/libosdp/build-and-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,14 @@ Cmake is the recommented way for building libosdp.

.. code:: sh
mkdir build && cd build
cmake ..
make
cmake -B build
cmake --build build --parallel
Optionally, you could install libosdp using,

.. code:: sh
# (optional)
make check
make DESTDIR=/your/install/path install
cmake --build build --target install
Make Build
----------
Expand All @@ -35,9 +36,6 @@ own Makefile to be chained in some other build system. Please see `configure.sh
./configure.sh
make
# (optional)
make check
Build html docs
---------------

Expand All @@ -46,9 +44,20 @@ HTML docs of LibOSDP depends on python3, pip3, doxygen, sphinx, and breathe.
.. code:: sh
pip3 install -r doc/requirements.txt
mkdir build && cd build
cmake ..
make html_docs
cmake -B build
cmake --build build --target html_docs --parallel
Running the test suite
----------------------

If you are adding features to LibOSDP, you might want to kick off the test
suite to ensure that you changes are valid and has not regressed any other
features. To do this run,

.. code:: sh
./scripts/run_tests.sh
Compile-time configuration options
----------------------------------
Expand Down
File renamed without changes.

0 comments on commit f6fb9d0

Please sign in to comment.