From d7db44b134c6970eeb57d714f4a0c2b6726f2f76 Mon Sep 17 00:00:00 2001
From: Nico Schottelius <nico@kr.ethz.ch>
Date: Fri, 4 Mar 2011 09:32:01 +0100
Subject: [PATCH] cdist update

---
 software/cdist.mdwn | 65 ++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 55 insertions(+), 10 deletions(-)

diff --git a/software/cdist.mdwn b/software/cdist.mdwn
index 15ec6507..8d9bff80 100644
--- a/software/cdist.mdwn
+++ b/software/cdist.mdwn
@@ -13,12 +13,14 @@ it ticks differently:
  * cdist sticks completly to the KISS (keep it simple and stupid) paradigma
   * cdist's core is very small (currently around 400 lines of code)
   * There is only one type to extend cdist called ***type***.
+  * One main development target: ***It must be incredible easy to add new types.***
  * cdist is UNIX
   * It reuses existing tools like cat, find, mv, ...
   * cdist's documentation is bundled as manpages
  * cdist is written in POSIX shell
   * No special requirements like high level interpreters needed on server or target
 
+
 ### Architecture
 
  * Push mode (server pushes configuration)
@@ -26,32 +28,75 @@ it ticks differently:
  * User defines configuration in shell scripts (called ***manifests***)
  * Cdist generates internal configuration (cconfig style) and afterwards applies configuration
 
+### Features
+
+Stuff that should probably be included in every configuration management,
+but is not. Or: The reason why I began to write cdist.
+
+ * Speed
+ * Elegant code
+ * Clean design
+ * Good documentation (man pages)
+ * Meaningful error messages
+ * No surprise factor
+ * Consistency in behaviour, naming and documentation
+ * Easy integration nacked installations
+ * Simple and well-known DSL: posix shell
+ * It is very easy to
+  * extend cdist
+  * debug cdist-core and cdist-types
+ * Focus on reuse of existing functionality
+  * ssh
+  * sh
+  * find, rm, ...
+
 ## Requirements
 
 ### Server
 
  * A posix like shell
- * SSH-Client (for push architecture)
- * SSH-Server (for pull architecture)
+ * SSH-Client
 
-### Client
+### Client ("target host")
 
  * A posix like shell
- * SSH-Client (for pull architecture)
- * SSH-Server (for push architecture)
+ * SSH-Server
 
-## How to get cdist
+
+## Getting cdist
+
+You can clone cdist from git, which gives you the advantage of having
+a version control in place for development of your own stuff as well.
+
+There are at least two branches available:
+
+ * 1.0: stable branch of version 1.0
+ * next: preparing next cdist version
+
+Other branches may be available as well for features or bugfixes, but they
+may vanish at any point.
+
+
+### Installation
+
+To install cdist, execute the following commands:
 
     git clone git://git.schottelius.org/cdist
+    cd cdist
+    export PATH=$PATH:$(pwd -P)/bin
 
-## How to install cdist
 
-    make install
+### Update
 
-## How to use cdist
+As the stable branch always contains the stable code, you can upgrade
+cdist using
 
-    man cdist
+    git pull
 
+If there are any incompatibilities, at least the minor version (1.0 -> 1.1)
+will change and thus a git pull will never break your cdist installation
+(in theory).
+ 
 ## Support
 
 ### IRC