diff options
| -rw-r--r-- | README.md | 8 | ||||
| -rw-r--r-- | README.rst | 56 |
2 files changed, 56 insertions, 8 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index 47c55aa..0000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# TODO - -* add flattr button (https://github.com/Schnouki/pelican-elegant/commit/83189e498730fe68c96defdf4b71a964a076a443) - http://developers.flattr.net/feed/ - http://developers.flattr.net/button/ - -* split music page into links to several project pages - diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..8b91263 --- /dev/null +++ b/README.rst @@ -0,0 +1,56 @@ +Sleep Map +######### +| This is the README for http://sleepmap.de. +| +| The website is constructed from + +* a |pelican| project (all content as reStructuredText, see *reStructuredText_CheatSheet.txt* for help). +* a subset of |pelican-plugins|, which are a submodule of this repository in the folder **pelican-plugins** +* a customized theme - have a look at the **theme** folder + +Getting the content +------------------- + +* Clone the repository + + .. code:: bash + + git clone git@sleepmap.de:sleepmap.git + +* Initialize all submodules + + .. code:: bash + + git submodule update --init --recursive + +Generating new content +---------------------- +| After editing pages or blog posts, re-generate the whole site by doing a simple + + .. code:: bash + + pelican + +| in the root directory of this repository. It will generate the whole website below the **output** folder. + +Upload new content +------------------ +| Uploading the new content now is as easy as doing a + + .. code:: bash + + make rsync_upload + +| in the root directory of this repository. +| This will automatically rsync the output folder with your remote website folder. + + + +.. |pelican| raw:: html + + <a href="https://getpelican.com" target="_blank">Pelican</a> + +.. |pelican-plugins| raw:: html + + <a href="https://github.com/getpelican/pelican-plugins/" target="_blank">Pelican Plugins</a> + |