aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorklondike <klondike@xiscosoft.es>2011-01-20 22:55:28 +0100
committerklondike <klondike@xiscosoft.es>2011-01-20 22:55:28 +0100
commit7add0c51e051ee859be6b764da376f8a6d1ca40d (patch)
tree6550b8d4911b8471b597057a4faa733e53b69474 /README_PREVIEWS
parentUpdating the preview (diff)
downloadhardened-docs-7add0c51e051ee859be6b764da376f8a6d1ca40d.tar.gz
hardened-docs-7add0c51e051ee859be6b764da376f8a6d1ca40d.tar.bz2
hardened-docs-7add0c51e051ee859be6b764da376f8a6d1ca40d.zip
Small guide for newcomers on how to do previews
Diffstat (limited to 'README_PREVIEWS')
-rw-r--r--README_PREVIEWS19
1 files changed, 19 insertions, 0 deletions
diff --git a/README_PREVIEWS b/README_PREVIEWS
new file mode 100644
index 0000000..52be3ec
--- /dev/null
+++ b/README_PREVIEWS
@@ -0,0 +1,19 @@
+For reading easiness it is recommended updating the previews only after commiting the changes and on a different
+posterior commmit, specially if the changes involve various docs.
+
+In order to be able to generate previews you need to have the gentoo xsl files and gorg installed and configured.
+
+Enter on the directory where you will hold the cvs docs
+cd $PATH
+
+First you need to get the xsl files, this is done with this cvs command:
+cvs -d :pserver:anonymous@anoncvs.gentoo.org/var/cvsroot co gentoo/xml
+
+Next you need to install gorg and configure it:
+emerge www-servers/gorg
+$EDITOR /etc/gorg/gorg.conf.sample
+
+There change root = to this (don't forget to replace $PATH):
+root = "$PATH/gentoo/xml/htdocs"
+
+Finally save it as /etc/gorg/gorg.conf and you are done, now you should be able to use the preview scripts :D