[guadec-web] Updated README file



commit 9881097221bd2427d001ff526359e42d93d685da
Author: Oliver Gutierrez <ogutsua gmail com>
Date:   Fri Mar 2 11:04:38 2018 +0000

    Updated README file

 README.md |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)
---
diff --git a/README.md b/README.md
index b25c6eb..916dc1d 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,7 @@ Once the command finishes the execution you will have a development webserver ru
 
     http://localhost:8000
 
+And every time you change content files or theme files they will be automatically regenerated to allow you 
to preview the changes you have done.
 
 ### Writing content
 
@@ -43,12 +44,25 @@ Article date must be in the format YYYYMMDD HH:MM:SS and the time is optional
 
 The pages works the same way the articles do. The difference is that pages are not shown in any category and 
they live at **content/pages** directory.
 
+If you need to create a new page, make sure you kink it from another page or in the menu (see configuration 
options below).
+
 #### Images and downloadable content
 
 The images are placed ad **content/images** directory and can be included into documents by using:
 
     ![ALT Text]({filename}/images/image-name.jpg "Image title")
 
+### Theme
+
+All theme files lives at **src** directory. The template files are written in HAML, and CSS is written using 
SASS. You will usually not need to modify the theme.
+
+### Deployment
+
+Once you have written the content you need to push your changes to the repository. Once that is done, there 
is a helper script you can execute to publish the changes in the website:
+
+    ./deploy.py
+
+This script will automatically generate all the theme and content information and then replace the contents 
in the guadec-2018 branch with the new generated content.
 
 ### Configuration options
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]