Fix bug #19: Tabs ignored in HTML export
[grauphel.git] / README.rst
index 8320eca..6afa808 100644 (file)
@@ -16,12 +16,12 @@ Status
 
 What works
 ==========
-- Authentication works
-- Note synchronization works
-- OAuth token management interface works
-- Database management interface (reset) works
+- Note synchronization
+- OAuth token management interface
+- Database management interface (reset)
 - Viewing notes
 - Searching notes
+- Downloading notes as HTML and reStructuredText
 
 What is missing
 ===============
@@ -81,19 +81,58 @@ 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 7, do the following::
+
+  $ apt-get install libpcre3-dev php-pear php5-dev
+  $ pecl install oauth
+  $ echo 'extension=oauth.so' > /etc/php5/conf.d/oauth.ini
+  $ /etc/init.d/apache2 restart
+
+Reload the ownCloud page in your browser now.
+
+
 ======
 Author
 ======
 Christian Weiske, cweiske@cweiske.de, http://cweiske.de/
 
 
-=========
-Home page
-=========
+=====
+Links
+=====
+- `Homepage`__
 - `grauphel on apps.owncloud.com`__
 - `Source code repository`__
 - `Github source code mirror`__
 
+__ http://cweiske.de/grauphel.htm
 __ http://apps.owncloud.com/content/show.php?action=content&content=166654
 __ http://git.cweiske.de/grauphel.git/
 __ https://github.com/cweiske/grauphel