diff --git a/README.rst b/README.rst index 9d7faf92..ecf0b33b 100644 --- a/README.rst +++ b/README.rst @@ -9,24 +9,12 @@ Pelican is a simple weblog generator, writen in python. * Easy to interface with DVCSes and web hooks * Completely static output, so easy to host anywhere ! -Getting started +Files metadatas --------------- -Yeah? You're ready? Let's go !:: - - $ pip install pelican - $ pelican -p /path/to/your/content/ - ... - -And… that's all! You can see your weblog generated on the content/ folder. - - -Metadata ---------- - Pelican tries to be smart enough to get the informations he needs from the -filesystem (for instance, about date of creation of the files), but it seems to -be less reliable than static metadata. +filesystem (for instance, about the category of your articles), but you need to +provide by hand some of those informations in your files. You could provide the metadata in the restructured text files, using the following syntax:: @@ -39,19 +27,47 @@ following syntax:: :category: yeah :author: Alexis Metaireau +Note that only the `date` metadata is mandatory, so you just have to add that in i +your files. The category can also be determined by the directory where the rst file +is. For instance, the category of `python/foobar/myfoobar.rst` is `foobar`. + +Getting started — Generate your blog +------------------------------------- + +Yeah? You're ready? Let's go ! You can install pelican in a lot of different +ways, the simpler one is via pip:: + + $ pip install pelican + +Then, you have just to launch pelican, like this:: + + $ pelican /path/to/your/content/ + +And… that's all! You can see your weblog generated on the content/ folder. + +This one will just generate a simple output, with the default theme. It's not +really sexy, as it's a simple HTML output (without any style). + +You can create your own style if you want, have a look to the help to see all +the options you can use:: + + $ pelican --help + Why the name "Pelican" ? ------------------------ Heh, you didnt noticed? "Pelican" is an anagram for "Calepin" ;) +Source code +----------- + +You can access the source code via mercurial at http://hg.notmyidea.org/pelican/ +or via git on http://github.com/ametaireau/pelican/ + Feedback ! ---------- If you want to see new features in Pelican, dont hesitate to tell me, to clone the repository, etc. That's open source, dude! -Source code ------------ - -Get the source code from http://hg.notmyidea.org/pelican/ - +Contact me at "alexis at notmyidea dot org" for any request/feedback !