inital checkin (base daemon should be running)

git-svn-id: https://svn.spreadspace.org/gcsd/trunk@2 ac14a137-c7f1-4531-abe0-07747231d213

1 files changed, 100 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..be747c3
--- /dev/null
+++ b/README
@@ -0,0 +1,100 @@
+Introduction
+============
+
+gcsd the generic command sequencer daemon can be used to serialize 
+commands sent over various paralell communication channels to a
+single command output. It can be seen as a multiplexer for any
+kind of communication between a single resource and various clients
+which want to submit commands to it or query information from it.
+gcsd is written in C and Lua. The goal is to provide an easy to 
+understand high level API based on Lua which can be used to
+implement the business logic of the so formed multiplexer daemon.
+
+
+Dependencies
+============
+
+Linux
+-----
+
+common:
+ build-essential
+ lua5.1
+ liblua5.1-0-dev
+ liblua5.1-socket2
+
+if you want to rebuild the manpage:
+ asciidoc
+
+
+FreeBSD
+-------
+
+common:
+ devel/gmake
+ lang/lua
+ net/luasocket
+ 
+
+Windows
+-------
+
+common:
+  MinGW and MSYS (details follow)
+  lua-5.1.x
+
+
+Installation
+============
+
+Getting the source via subversion:
+----------------------------------
+
+svn co https://svn.spreadspace.org/gcsd/trunk gcsd
+cd gcsd
+
+
+Building from source
+--------------------
+
+# cd src
+# ./configure
+# make
+
+Notes: 
+  - try './configure --help' for further information
+  - on FreeBSD you have to use gmake instead of make
+
+
+Building on Windows
+-------------------
+
+gcsd can be built on Windows using MinGW and MSYS..
+
+tba ...
+
+
+Installing
+----------
+
+# sudo make install
+
+This will install gcsd under the --prefix defined with configure.
+
+
+Uninstalling
+------------
+
+# sudo make remove
+
+This removes everytthing except for the config files
+
+# sudo make purge
+
+This also removes the config files
+
+
+Usage:
+======
+
+tba..