# HG changeset patch
# User Christophe Lincoln <pankso@slitaz.org>
# Date 1334086706 -7200
# Node ID 93d5438f419da88512d1770dc5441d4feb0aba02

Initial commit with README

diff -r 000000000000 -r 93d5438f419d README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Tue Apr 10 21:38:26 2012 +0200
@@ -0,0 +1,68 @@
+TinyCM - A micro CGI/SHell Content Manager!
+================================================================================
+
+
+	* CGI/Shell powered, small Wiki syntaxe and HTML JS editor helper
+	* Tiny, fast, elegent and easy to install and customize
+	* No database, flat file storage with diff and log
+	* Plugins support for any kind of functions such as a blog
+	* Help file with formating rules, macro and HTML example code
+	* Gettexte support and languages support for documents
+
+
+Installation
+------------
+You must first get TinyCM source code via a tarball on SliTaz mirrors or Hg 
+repository. You can extract or clone the CM under a web server directory,
+for security reason the config file have a .cgi extension and users data are
+stored outsite the web server in the directory /var/lib/slitaz. The user
+files paths can be changed via the configuration file.
+
+When you have your copy of TinyCM you can then install web interface under a
+CGI/SHell enabled web server such as Busybox HTTPd, LightTPD or Apache. Gettext
+must be installed for localisation support. So, let download Content Manager:
+
+	$ wget http://mirror.slitaz.org/sources/tinycm/tinycm-VERSION.tar.gz
+	$ tar xzf tinycm-VERSION.tar.gz
+	
+Or clone the Mercurial repo:
+	
+	$ hg clone http://hg.slitaz.org/tinycm
+
+
+Change directory to the CM, check and edit the configuration file config.cgi
+and use make to install:
+
+	$ cd tinycm*
+	$ editor config.cgi
+	$ make install
+
+
+Standalone Server
+-----------------
+On SliTaz you can install a copy of TinyCM somewhere under you $HOME directory
+and start the stand alone web server powered by Busybox HTTPd applet. This also
+help to debug TazCM since error messages are displayed in the terminal. To
+start the server, cd to TinyCM dir and execute:
+
+$ ./tinycm serv
+
+
+Mercurial integration
+---------------------
+TinyCM can smothily be integrated with Mercurial, each new document and edit
+will be committed. You must first edit you config.cgi configuration to 
+enable Hg with HG="yes" then login to your TinyCM follow the link to init the
+repo or do it manually: cd content && hg init && hg add && hg commit -m "Message"
+
+Then all content will be under Hg and people can commit as usual, to make sure
+we use the last files on the web interface we use a Hook to update the repo on
+each commit. To have the mercurial web interface for the repo you can setup
+a vhost, TinyCM provide a small web interface to display Hg log but it can
+be extented via a plugin. Hook for $content/.hg/hgrc:
+
+[hooks]
+incoming = hg update
+
+
+================================================================================