added command line and config parsing

1 files changed, 34 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..9c5aee8
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+biruda
+------
+
+The successor of 'build' (birua - Japanese for builder).
+
+The master:
+* receives build commands, orchestrates the build
+
+The coordinator:
+* manages resources (virtual machines, CPUs per chroot, etc.)
+
+The builder:
+* does the job (this can be build, test, etc.)
+
+Requirements
+------------
+
+* biruda is written in plain C and uses libraries written in plain C.
+  You need a C compiler and GNU make.
+* gengetopt: for command argument line parsing
+  http://www.gnu.org/software/gengetopt/gengetopt.html
+* confuse: configuration library
+  http://www.nongnu.org/confuse/
+* nanomsg: for communication between nodes (on the same machine or on several machines)
+  http://nanomsg.org/
+* libmicrohttpd: for an embedded web interface
+  http://www.gnu.org/software/libmicrohttpd/
+
+Other projects
+--------------
+
+* my own shell-script-based predecessor at http://github.com/Wolframe/build
+* buildbot
+* OpenSuseBuild service