Talk about validating
[grauphel.git] / README.rst
index 074a30e..96968df 100644 (file)
@@ -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
@@ -85,17 +91,32 @@ __ http://pecl.php.net/package/oauth
 Installation
 ============
 
 Installation
 ============
 
+.. note::
+   grauphel needs to be activated for all users.
+   It will not work with the "enable only for specific groups" setting.
+
+App store installation
+======================
+#. Log into owncloud as administrator
+#. Goto "Apps"
+#. Enable experimental apps in the settings
+#. Click "Productivity"
+#. Look for "grauphel - Tomboy sync server"
+#. Click "Activate"
+
+
 Manual installation
 ===================
 
 #. SSH onto your web server
 #. Navigate to the owncloud ``apps`` directory, often in ``/var/www/owncloud/apps``
 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.
+#. Download the latest release from http://cweiske.de/grauphel.htm#download
+   and extract it.
    For example::
 
    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
+     $ wget http://cweiske.de/download/grauphel/grauphel-0.6.4.tar.gz
+     $ tar xjvf grauphel-0.6.4.tar.gz
+     $ rm grauphel-0.6.4.tar.gz
 
    You do have a directory ``/var/www/owncloud/apps/grauphel`` now.
 #. Using your browser, login as administrator into ownCloud and click
 
    You do have a directory ``/var/www/owncloud/apps/grauphel`` now.
 #. Using your browser, login as administrator into ownCloud and click
@@ -108,13 +129,27 @@ 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-1.2.3
+  $ 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.
 
+.. note::
+   ``oauth-1.2.3`` is only needed on PHP 5.x
+   For PHP 7 simply use ``pecl install oauth``.
+
+
+========
+Download
+========
+.. LATESTRELEASE
+
+See `grauphel downloads page <http://cweiske.de/grauphel-download.htm>`_
+for all released versions.
 
 ======
 Author
 
 ======
 Author
@@ -145,3 +180,46 @@ 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.
+
+
+Unit testing
+============
+- `ownCloud unit testing documentation`__
+- `grauphel on Travis CI`__
+
+  .. image:: https://travis-ci.org/cweiske/grauphel.svg
+     :target: https://travis-ci.org/cweiske/grauphel
+
+__ https://doc.owncloud.org/server/8.0/developer_manual/core/unit-testing.html
+__ https://travis-ci.org/cweiske/grauphel
+
+
+Releasing grauphel
+==================
+To release a new version, do the following:
+
+#. Increase version number in ``appinfo/version`` and ``appinfo/info.xml``.
+#. Validate ``appinfo/info.xml``::
+
+     $ xmllint --noout --schema tools/info.xsd appinfo/info.xml
+
+#. Validate ``appinfo/database.xml``::
+
+     $ xmllint --noout --schema tools/database.xsd appinfo/database.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 with::
+
+     $ cd ~/Dev/html/cweiske.de
+     $ ./scripts/update-grauphel.sh
+
+#. Link the new release on https://apps.owncloud.com/content/show.php?content=166654