* Move to GPL v3
[citadel.git] / webcit / README.txt
index 20b9ef8cd24eccf336dd7e441c11e2800abb3099..f83693debc632db63d569960662dc1f7b839ff7a 100644 (file)
@@ -1,19 +1,19 @@
                         WEBCIT for the Citadel System
-                               version 7.02
+                               version 7.11
  
-   Copyright (C) 1996-2006 by the authors.  Portions written by:
+   Copyright (C) 1996-2007 by the authors.  Portions written by:
        Art Cancro
-       Nathan Bryant
-       Alessandro Fulciniti
        Wilifried Goesgens
+       Nathan Bryant
        Nick Grossman
        Andru Luvisi
+       Alessandro Fulciniti
        Dave Lindquist
        Matt Pfleger
        Martin Mouritzen
 
    This program is open source software released under the terms of the GNU
-   General Public License, version 2.  Please read COPYING.txt for more
+   General Public License, version 3.  Please read COPYING.txt for more
    licensing information.
  
    WebCit bundles the Prototype JavaScript Framework, writen by Sam
@@ -39,7 +39,7 @@
  INTRODUCTION
  ------------
  
- Citadel is a sophisticated groupware and BBS package which allows multiple
+ Citadel is a sophisticated groupware platform which allows multiple
 users to simultaneously access the system using a variety of user interfaces.
 This package (WebCit) is a "middleware" package which presents an HTML/HTTP
 user interface to the Citadel system.
@@ -176,6 +176,21 @@ ones which you may be interested in are:
  If you would like to deploy a "favicon.ico" graphic, please put it in
 the static/ directory.  WebCit will properly serve it from there.
  
+
+ CUSTOMIZATION
+ -------------
+
+ The default WebCit installation will create an empty directory called 
+"static.local".  In this directory you may place a file called "webcit.css"
+which, if present, is referenced *after* the default stylesheet.  If you
+know CSS and wish to customize your WebCit installation, any styles you
+declare in static.local/webcit.css will override the styles found in
+static/webcit.css -- and your customizations will not be overwritten when
+you upgrade WebCit later.
+
+ You may also place other files, such as images, in static.local for
+further customization.
+
  
  CALENDAR SERVICE
  ----------------
@@ -281,19 +296,22 @@ Here is how to configure the "subdirectory" method:
 If you are building packages and prefer not to have WebCit reside entirely in
 a single directory, there are several compile-time options available.
 
---with-staticdir defines where webcit should locate and search its templates and images. If you
-want to go with a different installation location then the point at which it is accessed at runtime, 
-you can use --with-staticrundir. This option is meant to ease your needs if you're going
-to install the static files as 'examples' in a location like /usr/share/doc/webcit/examples, 
-and enable the user to copy them over to another dir (like /var/lib/citadel/www), where 
-they're accessed at runtime. (The debian instatll scripts provided with this package 
-do this to preserve user changes to the template system, see debian/citadel-webcit.postinstall)
+--with-wwwdir defines where webcit should locate and search its templates and images. 
+--with-localedir defines where to put webcits locale files.
 
 Also, there are possibilities to load the TinyMCE editor into a system-wide location.  WebCit 
 uses this standard component to compose its messages for messages and postings. Several WebCit installations
 that may differ in design but use the same TinyMCE (which is the default that WebCit ships with)
 (set --with-editordir for that, it defaults to the dir the templates go)
 
+Install targets have diversified to reflect these changes too:
+ (make install-.....)
+locale: the webcit .mo files for gettext & locales.
+tinymce: the editor. if your system brings one, just ommit this.
+wwwdata: our templates.
+setupbin: if you want to use webcits setup facility... but isn't needed in case you provide own init & config scripts.
+bin: the binaries.
+
 
  CONCLUSION
  ----------