From f2542128ff909430bd60789e8b5923543c9d42a1 Mon Sep 17 00:00:00 2001 From: Tomasz Kramkowski Date: Fri, 23 Jul 2021 16:03:58 +0100 Subject: Update readme --- README.md | 16 +++++++++++++--- 1 file 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 - Tested building and development. Slightly overzealous rebuilds. Performance issues with jobserver. @@ -16,8 +18,10 @@ Dependencies bugs when used for development. - 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 . + +Bugs +---- + +* pack assumes a two's complement implementation of C +* pack cannot build on OSX without installing a newer bash and a fixed xargs -- cgit v1.2.3-54-g00ecf