Skip to content

Commit

Permalink
doc: Add some notes about make build
Browse files Browse the repository at this point in the history
Reported-by: #151
Signed-off-by: Siddharth Chandrasekaran <[email protected]>
  • Loading branch information
sidcha committed Dec 14, 2023
1 parent f52cbcd commit f21c7d4
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ $(O)/pd_app.elf: $(O)/libosdp.a

.PHONY: check
check: CCFLAGS_EXTRA=-DUNIT_TESTING -Iutils/include -Iinclude -Isrc -I$(O)
check: $(OBJ_TEST)
check: clean $(OBJ_TEST)
@echo "LINK $@"
$(Q)$(CC) $(CCFLAGS) $(OBJ_TEST) -o $(O)/unit-test
$(Q)$(O)/unit-test
Expand Down
24 changes: 24 additions & 0 deletions doc/libosdp/build-and-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,38 @@ This repository produces a ``libosdpstatic.a`` and ``libosdp.so``. You can link
these with your application as needed (-losdp or -losdpstatic). Have a look at
``sample/*`` for details on how to consume this library.

This project supports two kinds of build systems: cmake and make.

Cmake Build
-----------

Cmake is the recommented way for building libosdp.

.. code:: sh
mkdir build && cd build
cmake ..
make
# (optional)
make check
make DESTDIR=/your/install/path install
Make Build
----------

The make build is provided as a reference for people who wish to write their
own Makefile to be chained in some other build system. Please see `configure.sh
--help` for different configuration options.

.. code:: sh
./configure.sh
make
# (optional)
make check
Build html docs
---------------

Expand Down

0 comments on commit f21c7d4

Please sign in to comment.