Changeset - d0eb4a56e465
[Not reviewed]
0 1 0
Michael Guravage (guravage) - 11 years ago 2015-01-08 20:27:10
m.a.guravage@cwi.nl
First of many corrections to README.txt.
1 file changed with 4 insertions and 2 deletions:
0 comments (0 inline, 0 general)
README.txt
Show inline comments
 
@@ -46,25 +46,25 @@ content. While you can install the template anywhere you like, for
 
this example, please clone the cwi-pelican-template in the root of
 
your Pelican virtual environment. Don't forget to use your own
 
username in the url::
 

	
 
    git clone https://<username>@scm.cwi.nl/ITF/cwi-pelican-template cwi
 

	
 
Installing the Pelican CWI theme
 
--------------------------------
 

	
 
The cwi project template uses a corresponding CWI theme, but it must
 
be installed before Pelican can use it::
 

	
 
    pelican-theme --symlink ${PWD}/cwi/theme/cwi
 
    pelican-themes --symlink ${PWD}/cwi/theme/cwi
 

	
 
Usage
 
=====
 

	
 
To generate html output, go to the project directory and invoke Pelican via make::
 

	
 
    cd cwi/projects/cwi
 
    make html
 

	
 
Previewing
 
----------
 

	
 
@@ -75,25 +75,27 @@ you can regenerate the HTML and serve it in one command::
 

	
 
The server uses port 8000 by default. After starting the server point
 
you browser to the url: localhost:8000.
 

	
 

	
 
Uploading the generated HTML to a server
 
----------------------------------------
 

	
 
The Pelican Makefile contains several targets for uploading its generated HTML. List all make's targets with::
 

	
 
    make -n
 

	
 
To use rsync, edit the Makefile and customize the values of SSH_HOST, SSH_USER anad SSH_Target_DIR.
 
To use rsync, edit the Makefile and customize the values of SSH_HOST,
 
SSH_USER anad SSH_Target_DIR.  Of course, this assumes you've already
 
spoken with someone at ITF to arrange a CWI vhost to host your site.
 

	
 

	
 
Creating new Pelican projects
 
-----------------------------
 

	
 
Pelican provides a scrip, appropriately named 'pelican-quickstart', to
 
help create new project hierarchies.  To use it, go to the projects
 
directory and invoke 'pelican-quickstart' at the command prompt. The
 
script will solicit your answers to a number of questions, and
 
generate your new project hierarchy accordingly.
 

	
 

	
0 comments (0 inline, 0 general)