Hack around with readme

Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
Nico Schottelius 2010-12-01 20:06:07 +01:00
parent 2f415ad240
commit 3709be353b
3 changed files with 68 additions and 49 deletions

18
HACHERS_README Normal file
View file

@ -0,0 +1,18 @@
Hey hackers,
cdist has not been published, you're accessing a early in developent
code.
Do not believe anything written in cdist, besides what's written in this file
(everything else may be future stuff for the initial release).
-- Nico, 20101201
What you can do so far:
# prepare use:
export PATH="$PATH:$(pwd -P)/bin"
## Test config tree wrapper
cd test && ./cdist-cconfig-tree

49
README
View file

@ -1,49 +0,0 @@
## Introduction
cdist configures your system. It is similar to
[cfengine](http://www.cfengine.org/) and [puppet](http://www.puppetlabs.com/).
It is inspired by both of those tools:
* Try to redo the great power you get
* But leave out the bugs you also got
And cdist is UNIX:
It's designed to
reuse existing tools,
it does not require high level scripting language interpreters
and it is equipped with manpages.
### Architecture
* KISS (keep it simple and stupid)
* Allow very easy extension of cdist (creating own types for instance)
* Push (server pushes configuration) and Pull (client retrieves config) supported
* User defines configuration in shell scripts using cdist functions
* Cdist generates internal configuration (cconfig style) and afterwards applies configuration
## Requirements
### Server
* A posix like shell
* SSH-Client (for push architecture)
* SSH-Server (for pull architecture)
### Client
* A posix like shell
* SSH-Client (for pull architecture)
* SSH-Server (for push architecture)
## How to get cdist
git clone git://git.schottelius.org/cdist
## How to install cdist
make install
## How to use cdist
man cdist

1
README Symbolic link
View file

@ -0,0 +1 @@
HACHERS_README

49
REAL_README Normal file
View file

@ -0,0 +1,49 @@
## Introduction
cdist configures your system. It is similar to
[cfengine](http://www.cfengine.org/) and [puppet](http://www.puppetlabs.com/).
It is inspired by both of those tools:
* Try to redo the great power you get
* But leave out the bugs you also got
And cdist is UNIX:
It's designed to
reuse existing tools,
it does not require high level scripting language interpreters
and it is equipped with manpages.
### Architecture
* KISS (keep it simple and stupid)
* Allow very easy extension of cdist (creating own types for instance)
* Push (server pushes configuration) and Pull (client retrieves config) supported
* User defines configuration in shell scripts using cdist functions
* Cdist generates internal configuration (cconfig style) and afterwards applies configuration
## Requirements
### Server
* A posix like shell
* SSH-Client (for push architecture)
* SSH-Server (for pull architecture)
### Client
* A posix like shell
* SSH-Client (for pull architecture)
* SSH-Server (for push architecture)
## How to get cdist
git clone git://git.schottelius.org/cdist
## How to install cdist
make install
## How to use cdist
man cdist