update documentation
[cmcms:cmcms.git] / README
1 cmcms == CMCMS Content Management System
2 ========================================
3
4
5 Usage
6 -----
7
8 /path/to/cmcms.ch /another/path/to/website.conf
9
10
11 Configuration file
12 ------------------
13
14 NAME  The name of the site; appears in titles, feeds, ...
15 URL   The base url of the output site; appears in RSS feeds.
16 OUT   The output directory; relative to config file or absolute.
17 TMP   Temporary directory; relative to config file or absolute.
18
19
20 Hardcoded paths (relative to configuration file)
21 ------------------------------------------------
22
23 pages/*.xml       page definititions
24 static/*          extra files to copy to output
25 static/cmcms.css  main default screen stylesheet
26 static/print.css  printable format stylesheet
27 theme/header.xml  page header xhtml snippet
28 theme/footer.xml  page footer xhtml snippet
29
30
31 Hardcoded texts
32 ---------------
33
34 " :: " separates pagename from sitename in <title> tag of HTML and RSS
35 probably some more...
36
37
38 Legal
39 -----
40
41 Copyright (C) 2008,2009,2010  Claude Heiland-Allen <claudiusmaximus@goto10.org>
42
43 This program is free software: you can redistribute it and/or modify
44 it under the terms of the GNU Affero General Public License as published by
45 the Free Software Foundation, either version 3 of the License, or
46 (at your option) any later version.
47
48 This program is distributed in the hope that it will be useful,
49 but WITHOUT ANY WARRANTY; without even the implied warranty of
50 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
51 GNU Affero General Public License for more details.
52
53 You should have received a copy of the GNU Affero General Public License
54 along with this program.  If not, see <http://www.gnu.org/licenses/>.