2007-03-14 Marek Habersack <mhabersack@novell.com>

[mono.git] / web / README

diff --git a/web/README b/web/README
index 333d133943f56239c977b9c4c33f25652cf794bf..f10cd5d88dee37e319d3381f5573d43f15af2eda 100644 (file)
--- a/web/README
+++ b/web/README
@@ -15,3 +15,40 @@ To publish changes:
 
 cd web
 make push
+
+################ Requirements
+
+You must have complete and working "mono" and "mcs" checkouts from
+CVS. You will probably need to bootstrap your Mono installation,
+although an existing install from RPMs may permit you to build the CVS
+versions more easily.
+
+############## Samples 
+
+
+  If you want to add a new item in the left menu 
+  you have to edit mono/doc/web/commands and add
+  the entry there.
+
+    For new files you can add something as:
+    level,entry,path_to_the_file,file.src
+
+    ex: 1,COBOL#,cobol.html,cobol.src
+
+    If you just want to add a link to the menu:
+    1,MyEntry,URL
+    
+    ex: 1,About Linux,http://www.linux.org
+
+  To test the results under Linux:
+    1. Edit mono/doc/web/makefile
+
+    Delete all the references to class status
+    and the deploy/index.rss as well as the
+    mono.exe commands.
+
+    2. make
+    3. Open your browser and point to the 
+       file:///(YOUR PATH HERE)mono/doc/web/deploy/index.html
+
+