aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: a6a337cb38c09e33aca1dc6635900f1cf9b06814 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
Pack
====

Pack is a simple serialisation and deserialisation library for C.

Dependencies
------------

- A DJB redo compatible redo implementation
- A relatively recent copy of bash
- gcc with C11 support (To use clang, edit `link` and `default.o.do`)

Compilation
-----------

Optionally run `./configure release` to enable good additional default flags.
Alternatively, copy the files in `args/release/` to the project root and add
additional linker or compiler arguments necessary to build on your machine into
link.args and compile.args respectively. Please report flags necessary to build
on your platform so that they can be documented and potentially even
auto-detected.

Run `redo` to build the code and tests.

Testing
-------

Run `test` to run all the tests.

Development
-----------

Development args for the compiler and linker are stored in `args/devel/` and can
be copied from there manually or symlinked with `./configure devel`.

Contributing
------------

To contribute, please send a patch to me at <tk+pack-patches@the-tk.com>.