aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTharre <tharre3@gmail.com>2014-04-08 09:19:33 +0200
committerxRamses <tharre3@gmail.com>2014-04-08 09:19:33 +0200
commitc766f073e60c3aa51a3cc1555af87ded5823e5a0 (patch)
tree43595070e833b251b3f7ac7e94e5e992918194ef /README.md
downloadredo-c766f073e60c3aa51a3cc1555af87ded5823e5a0.tar.gz
redo-c766f073e60c3aa51a3cc1555af87ded5823e5a0.tar.xz
redo-c766f073e60c3aa51a3cc1555af87ded5823e5a0.zip
Initial codebase
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b722ebb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# What is redo?
+`redo` provides an elegant and minimalistic way of rebuilding files from source. The design stems from Daniel J. Bernstein, who published a basic concept about how `redo` should work on his [website](http://cr.yp.to/redo.html).
+
+If you want more detailed information about `redo`, a working python implementation of `redo` already exists [here](https://github.com/apenwarr/redo).
+
+# About this implementation
+The goal of this project is not only to implement `redo` in C, but also to rethink and improve it. This also means that this project will not try be compatible with other implementations of `redo`, although this shouldn't prove problematic.
+
+# Project status
+The is work in progress, many features are still missing and the behaviour is not set in stone yet. Missing features include dependency checking, parallel builds, recursive checking and probably a lot more. \ No newline at end of file