Skip to content

Fix typo and add build option explanation #3

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

Merged
leejonghyeong merged 1 commit into from
Dec 3, 2025
Merged

Fix typo and add build option explanation #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ You should supply `$ALEA_BUILD_DIR` for your preference.
| Build Options | What it is | Default |
| --------------------- | ---------------------------------------------------------- | ----------- |
| `BUILD_SHARED_LIBS` | Build a shared library instead of a static one | `OFF` |
| `ALEA_BUILD_TEST` | Build and enable the CTest-based unit tests | `ON` |
| `ALEA_BUILD_DOXYGEN` | Generate API documentation via Doxygen | `OFF` |
| `ALEA_INSTALL` | Install the Alea library, headers, and CMake package configuration files | `ON` |

## How to Test

Expand All @@ -30,6 +33,6 @@ ctest --test-dir $ALEA_BUILD_DIR
```

## License
deb is licensed under the Apache License 2.0, which means that you are free to get and use it for commercial and non-commercial purposes as long as you fulfill its conditions.
alea is licensed under the Apache License 2.0, which means that you are free to get and use it for commercial and non-commercial purposes as long as you fulfill its conditions.

See the LICENSE file for more details.