prepare release of 0.5.1

[grauphel.git] / README.rst

diff --git a/README.rst b/README.rst
index 8320eca16b6464b6f1991dbd60bdee3ef75836e7..22aa44abc5b38a5123dfa98cb948ac7c2694ef34 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -3,25 +3,27 @@ grauphel - tomboy REST server
 *****************************
 ownCloud__ application implementing the `Tomboy`__ `REST API`__ for syncing notes.
 
 *****************************
 ownCloud__ application implementing the `Tomboy`__ `REST API`__ for syncing notes.
 

-Work in progress.
+Pretty stable.

 
 __ http://owncloud.org/
 __ https://wiki.gnome.org/Apps/Tomboy
 __ https://wiki.gnome.org/Apps/Tomboy/Synchronization/REST/1.0
 
 
 
 __ http://owncloud.org/
 __ https://wiki.gnome.org/Apps/Tomboy
 __ https://wiki.gnome.org/Apps/Tomboy/Synchronization/REST/1.0
 
 

+.. contents::
+

 ======
 Status
 ======
 
 What works
 ==========
 ======
 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
 - Viewing notes
 - Searching notes

+- Downloading notes as HTML and reStructuredText

 
 What is missing
 ===============
 
 What is missing
 ===============


@@ -49,6 +51,10 @@ grauphel 0.2.1 is known to work with:
 * Tomboy 1.15.1, Windows
 * Tomdroid 0.7.5, Android 4.4.1
 
 * Tomboy 1.15.1, Windows
 * Tomdroid 0.7.5, Android 4.4.1
 

+See the HowTo__ document for client-specific configuration instructions.
+
+__ docs/howto.rst
+

 
 =============
 Functionality
 
 =============
 Functionality


@@ -81,19 +87,58 @@ Dependencies
 __ http://pecl.php.net/package/oauth
 
 
 __ 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.1.tar.bz2
+     $ tar xjvf grauphel-0.5.1.tar.bz2
+     $ rm grauphel-0.5.1.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/
 
 
 ======
 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`__
 
 - `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
 __ http://apps.owncloud.com/content/show.php?action=content&content=166654
 __ http://git.cweiske.de/grauphel.git/
 __ https://github.com/cweiske/grauphel


@@ -108,3 +153,22 @@ Development hints
   output.
 * ``latest-sync-revision`` sent from Tomboy during PUT sync is already
   incremented by 1.
   output.
 * ``latest-sync-revision`` sent from Tomboy during PUT sync is already
   incremented by 1.

+
+
+Releasing grauphel
+==================
+To release a new version, do the following:
+
+#. Increase version number in ``appinfo/version`` and ``appinfo/info.xml``.
+#. Fill the ``ChangeLog`` file with the changes since the last release,
+   mention the new version number.
+#. Update ``README.rst`` and increase the version number
+#. Create the grauphel release file with::
+
+     $ phing
+
+   The file will be in ``dist/``
+#. Test the release on a server
+#. Tag the release in git
+#. Upload the release to http://cweiske.de/grauphel.htm
+#. Link the new release on https://apps.owncloud.com/content/show.php?content=166654