release instructions

[grauphel.git] / README.rst

diff --git a/README.rst b/README.rst
index 074a30ea0d1baecfb9cb07405e12d188c12b4e14..76b6c0b529d6de852b48351246e963b5c92962b3 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -3,13 +3,15 @@ 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
 ======
 ======
 Status
 ======


@@ -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


@@ -108,9 +114,11 @@ 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.
   PHP extension "oauth" is required
 
 You have to install the PHP PECL oauth extension now.

-On Debian, do the following::
+On Debian 7, do the following::

 
 

-  $ apt-get install php5-oauth
+  $ 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.
   $ /etc/init.d/apache2 restart
 
 Reload the ownCloud page in your browser now.


@@ -145,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