Skip to content

docs: added note about install step requirement to readme #56

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.

Sign up for GitHub

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
vbartak wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

docs: added note about install step requirement to readme #56

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ec38cb
docs: added note about install step requirement to readme
Apr 9, 2026
9489d40
feat: debug note in readme
Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ For exact dependency versions used in the build, see [cmake/Dependencies.cmake](
mkdir -p _build && cd _build
cmake ../ -DCMLIB_DIR=</absolute/path/cmakelib>
make
cmake --install . [--prefix <custom path>] # sets up runtime library paths; running the binary directly from the build directory is not supported
```

## Run
Expand All @@ -57,6 +58,12 @@ make
./module-gateway-app --config-path=../resources/config/default.json
```

## Debug
Without the install step dynamic libraies are not found directly. This is not tested properly, but it is most probably necessary to pass LD_LIBRARY_PATH while running the executable. Tested only with release build without the install step.
```
LD_LIBRARY_PATH=../_tmp/cache/dir/EXTRACTED/BACPACK/AERON/DEBUG/lib:$LD_LIBRARY_PATH ./module-gateway-app
```

### Arguments

* Required arguments:
Expand Down