prepare release of 0.5.0

[grauphel.git] / README.rst

diff --git a/README.rst b/README.rst
index 61f4559278e38b4bc399315e6696db0fd947616e..074a30ea0d1baecfb9cb07405e12d188c12b4e14 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -21,6 +21,7 @@ What works
 - Database management interface (reset)
 - Viewing notes
 - Searching notes
+- Downloading notes as HTML and reStructuredText
 
 What is missing
 ===============
@@ -80,6 +81,41 @@ Dependencies
 __ http://pecl.php.net/package/oauth
 
 
+============
+Installation
+============
+
+Manual installation
+===================
+
+#. SSH onto your web server
+#. Navigate to the owncloud ``apps`` directory, often in ``/var/www/owncloud/apps``
+#. Download the latest release from http://cweiske.de/grauphel.htm and extract it.
+   For example::
+
+     $ wget http://cweiske.de/download/grauphel/grauphel-0.5.0.tar.bz2
+     $ tar xjvf grauphel-0.5.0.tar.bz2
+     $ rm grauphel-0.5.0.tar.bz2
+
+   You do have a directory ``/var/www/owncloud/apps/grauphel`` now.
+#. Using your browser, login as administrator into ownCloud and click
+   the "Apps" icon in the main menu ("+" icon).
+#. Click on "Grauphel: Tomboy note server" and then on the "Enable" button.
+#. In the main menu, click the "Tomboy notes" icon.
+
+It may be that grauphel now shows you an error message::
+
+  PHP extension "oauth" is required
+
+You have to install the PHP PECL oauth extension now.
+On Debian, do the following::
+
+  $ apt-get install php5-oauth
+  $ /etc/init.d/apache2 restart
+
+Reload the ownCloud page in your browser now.
+
+
 ======
 Author
 ======