aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 10 insertions, 5 deletions
diff --git a/README.md b/README.md
index ddfec17..293a1c7 100644
--- a/README.md
+++ b/README.md
@@ -6,26 +6,31 @@ Pack is a simple serialisation and deserialisation library for C.
Dependencies
------------
-- A apenwarr redo compatible redo implementation
+- A redo implementation (Tested with apenwarr and jdebp)
- A relatively recent copy of bash
-- A c compiler with C11 support
+- A C compiler with C11 support
Compilation
-----------
Run `./configure` (see `./configure -h` for additional options).
-Run `redo all` to build the code and tests.
+Run `redo all` to build the library and tests.
Testing
-------
Run `./test` to run all the tests.
+Installation
+------------
+
+Not implemented yet.
+
Development
-----------
-Please configure with `-w` and ensure code compiles cleanly. Although compiler
-versions can enable different warnings.
+Please configure with `-w` and ensure code compiles cleanly. Be aware that
+different compiler versions can enable different warnings. If in doubt, ask.
Contributing
------------