Add README.md and LICENSE

2 files changed, 59 insertions, 0 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..027c53c
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,20 @@
+Copyright 2020 Tomasz Kramkowski <tk@the-tk.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a6a337c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,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>.