aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTomasz Kramkowski <tk@the-tk.com>2021-07-23 16:03:58 +0100
committerTomasz Kramkowski <tk@the-tk.com>2021-07-23 16:03:58 +0100
commitf2542128ff909430bd60789e8b5923543c9d42a1 (patch)
tree88d5fb0729a54db4a975a36f59ed5b6fa255c330
parent5b4b1a4867b888bce0d58c7e5c418ebc189cc2c8 (diff)
downloadpack-f2542128ff909430bd60789e8b5923543c9d42a1.tar.gz
pack-f2542128ff909430bd60789e8b5923543c9d42a1.tar.xz
pack-f2542128ff909430bd60789e8b5923543c9d42a1.zip
Update readme
-rw-r--r--README.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/README.md b/README.md
index 7e19bdf..a1e160a 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,9 @@ Pack is a simple serialisation and deserialisation library for C.
Dependencies
------------
-- A redo implementation.
+Pack has no runtime dependencies. The following is a list of build dependencies:
+
+- An implementation of redo
- <http://news.dieweltistgarnichtso.net/bin/redo-sh.html> Tested building
and development. Slightly overzealous rebuilds. Performance issues with
jobserver.
@@ -16,8 +18,10 @@ Dependencies
bugs when used for development.
- <https://github.com/leahneukirchen/redo-c/> Tested for building.
Overzealous rebuilds but generally very fast.
-- A relatively recent copy of bash and some other core utilities.
-- A C compiler with C11 support.
+- A C11 compiler with GCC style parameters (clang works)
+- POSIX cat, find, rm, sed, sh and tr
+- xargs with support for the `-r` gnu extension
+- bash 4.4 or newer (parameter expansion transformations)
Compilation
-----------
@@ -45,3 +49,9 @@ Contributing
------------
To contribute, please send a patch to me at <tk+pack-patches@the-tk.com>.
+
+Bugs
+----
+
+* pack assumes a two's complement implementation of C
+* pack cannot build on OSX without installing a newer bash and a fixed xargs