From 31f9dcd7a525c0c403ec89976b49ce0023eade3b Mon Sep 17 00:00:00 2001
From: David Runge <dave@sleepmap.de>
Date: Sun, 25 Oct 2015 12:31:35 +0100
Subject: README.rst: Adding new README in ReStructuredText.

---
 README.rst | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.rst

(limited to 'README.rst')

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>
+
-- 
cgit v1.2.3