summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
index c808c3d..e9c37fa 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,29 @@
C parser for [POM configuration language](https://pom.computer)
+## About
+
+libpom has
+
+- small size (~20KB code+data)
+- support for custom memory allocation
+- no dependencies other than libc
+
+## Building
+
+Build with
+
+```
+make -j`nproc`
+```
+
+Install with
+```
+sudo make install
+```
+
+You can also do `PROFILE=Debug make` to build with debug information.
+
## Basic usage
```c
@@ -25,6 +48,10 @@ int main(void) {
}
```
+Assuming you have run `make install`, you just need to add `-l:libpom.a` (or `-lpom` to
+use the shared library) to your compiler flags.
+
+
See `examples/` directory for more examples.
## Contributing