diff README @ 346:dfc40e532bb6

Add a section about various subrepos of hg-website
author David Soria Parra <dsp@php.net>
date Mon, 22 Nov 2010 10:16:29 +0100
parents d662cba2afb1
children 29d4b5e45423
line wrap: on
line diff
--- a/README	Sat Nov 20 12:31:45 2010 +0100
+++ b/README	Mon Nov 22 10:16:29 2010 +0100
@@ -8,6 +8,17 @@
 * Instead of using Django to serve the site, use Blatter to generate a static version which can then be served by a normal webserver like Apache or nginx.
 * Move all the content into a subrepository so volunteers can just clone that repository if they just want to edit the content.
 
+Repository
+---------
+The repository is split into three subrepositories. The `main` repository contains
+scripts and templates to render the page. The `content` repository contains the
+content of each page and defines the structure of the website. The `rendered`
+repository contains the auto-generated pages.
+
+If you want to help out with patches, you usually just edit hg-website and hg-website-content
+and generate the rendered pages using blatter (or leave that tasks for the
+maintainer). 
+
 Setup
 -----
 
@@ -37,8 +48,8 @@
 
 You can then visit [http://localhost:8008](http://localhost:8008) to view the site.
 
-To render a static version of the site into the `out/` directory:
+To render a static version of the site into the `rendered/` directory:
 
     blatter blat
 
-For more information on using blatter, check the README file at [http://bitbucket.org/sjl/blatter/src/](http://bitbucket.org/sjl/blatter/src/)
\ No newline at end of file
+For more information on using blatter, check the README file at [http://bitbucket.org/sjl/blatter/src/](http://bitbucket.org/sjl/blatter/src/)