about summary refs log tree commit diff
diff options
context:
space:
mode:
authorLeah Neukirchen <leah@vuxu.org>2020-10-01 18:15:36 +0200
committerLeah Neukirchen <leah@vuxu.org>2020-10-01 18:15:36 +0200
commitc19b03dc4c656109833c3af6924bfb314c9fbfdc (patch)
tree9245ae6d070f3e5e6785fa02f4da625c581ab5a4
parent3a3f0056f357b4fa2b9f725725806d370395ff39 (diff)
downloadredo-c-c19b03dc4c656109833c3af6924bfb314c9fbfdc.tar.gz
redo-c-c19b03dc4c656109833c3af6924bfb314c9fbfdc.tar.xz
redo-c-c19b03dc4c656109833c3af6924bfb314c9fbfdc.zip
add README.md v0.3
-rw-r--r--README.md (renamed from NOTES)21
1 files changed, 20 insertions, 1 deletions
diff --git a/NOTES b/README.md
index 383acf6..89c0d9b 100644
--- a/NOTES
+++ b/README.md
@@ -1,4 +1,16 @@
-= Notes about the redo-c implementation of redo
+# redo-c
+
+redo-c is an implementation of the redo build system (designed by
+Daniel J. Bernstein) in portable C with zero external dependencies.
+
+## Documentation
+
+Please refer to the documentation for
+[redo in Python])(https://github.com/apenwarr/redo/blob/master/README.md),
+or the [tutorial by Jonathan de Boyne Pollard](http://jdebp.eu/FGA/introduction-to-redo.html)
+for usage instructions.
+
+## Notes about the redo-c implementation of redo
 
 * Without arguments, `redo` behaves like `redo all`.
 
@@ -34,3 +46,10 @@
 * `redo -f` will consider all targets outdated and force a rebuild.
 
 * `redo -k` will keep going if a target failed to build.
+
+## Copying
+
+To the extent possible under law, Leah Neukirchen <leah@vuxu.org>
+has waived all copyright and related or neighboring rights to this work.
+
+http://creativecommons.org/publicdomain/zero/1.0/