summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorpommicket <pommicket@gmail.com>2025-09-16 21:49:54 -0400
committerpommicket <pommicket@gmail.com>2025-09-16 21:49:54 -0400
commit966eaa9bf1c3120d3ac55c99f89025a37fdb87a0 (patch)
treec33ad0179d792a434ae3353d7b1bf5d0c687bb90 /README.md
parent49000be20eb598db55c24a1e982a3b6b0b581eeb (diff)
Better READMEs
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/README.md b/README.md
index e9c37fa..47a7b1a 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,15 @@
# libpom
-C parser for [POM configuration language](https://pom.computer)
+C/C++ parser for [POM configuration language](https://pom.computer).
+
+This library is implemented in C, with C++-friendly bindings available as well.
+See dedicated C++ README [here](cpp/README.md).
## About
libpom has
-- small size (~20KB code+data)
+- small size (~30KB code+data)
- support for custom memory allocation
- no dependencies other than libc
@@ -25,6 +28,18 @@ sudo make install
You can also do `PROFILE=Debug make` to build with debug information.
+The `Makefile` creates a build directory and runs cmake for you by default.
+You can also do this manually for more control over cmake options:
+
+```
+mkdir special-build
+cd special-build
+# e.g. don't build C++ library, tests, or examples
+cmake -DLIBPOM_CXX=OFF -DLIBPOM_TESTS=OFF -DLIBPOM_EXAMPLES=OFF -DCMAKE_BUILD_TYPE=Release ..
+make -j`nproc`
+```
+
+
## Basic usage
```c