Release 0.6.5

[grauphel.git] / README.rst

diff --git a/README.rst b/README.rst
index 76b6c0b529d6de852b48351246e963b5c92962b3..e3414532a4c8f1b744cb2917978f5e3a7242bc46 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,11 +1,11 @@
 *****************************
 grauphel - tomboy REST server
 *****************************
-ownCloud__ application implementing the `Tomboy`__ `REST API`__ for syncing notes.
+nextCloud__ application implementing the `Tomboy`__ `REST API`__ for syncing notes.
 
 Pretty stable.
 
-__ http://owncloud.org/
+__ https://nextcloud.com/
 __ https://wiki.gnome.org/Apps/Tomboy
 __ https://wiki.gnome.org/Apps/Tomboy/Synchronization/REST/1.0
 
@@ -62,7 +62,7 @@ Functionality
 
 Search
 ======
-You can use ownCloud's global search on the top right.
+You can use nextCloud's global search on the top right.
 
 During search, the note's titles, tags and content are searched.
 
@@ -91,20 +91,35 @@ __ http://pecl.php.net/package/oauth
 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 nextcloud 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``
-#. Download the latest release from http://cweiske.de/grauphel.htm and extract it.
+#. Navigate to the nextcloud ``apps`` directory, often in ``/var/www/nextcloud/apps``
+#. Download the latest release from http://cweiske.de/grauphel.htm#download
+   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
+     $ wget http://cweiske.de/download/grauphel/grauphel-0.6.5.tar.gz
+     $ tar xjvf grauphel-0.6.5.tar.gz
+     $ rm grauphel-0.6.5.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/nextcloud/apps/grauphel`` now.
+#. Using your browser, login as administrator into nextCloud 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.
@@ -117,13 +132,25 @@ 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
+  $ 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.
+Reload the nextCloud 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
 ======
@@ -134,12 +161,12 @@ Christian Weiske, cweiske@cweiske.de, http://cweiske.de/
 Links
 =====
 - `Homepage`__
-- `grauphel on apps.owncloud.com`__
+- `grauphel on apps.nextcloud.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://apps.nextcloud.com/apps/grauphel
 __ http://git.cweiske.de/grauphel.git/
 __ https://github.com/cweiske/grauphel
 
@@ -155,11 +182,31 @@ Development hints
   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
@@ -170,5 +217,10 @@ To release a new version, do the following:
    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
+#. Upload the release to http://cweiske.de/grauphel.htm with::
+
+     $ cd ~/Dev/html/cweiske.de
+     $ ./scripts/update-grauphel.sh
+
+#. Upload the new release on
+   https://apps.nextcloud.com/developer/apps/releases/new