From 4e04131d2ff615c217d0b2ddceb7ecff4a4e2feb Mon Sep 17 00:00:00 2001 From: Christian Weiske Date: Thu, 26 May 2011 22:00:08 +0200 Subject: [PATCH] make readme proper rST --- doc/README.txt | 90 ++++++++++++++++++-------------------------------- 1 file changed, 33 insertions(+), 57 deletions(-) diff --git a/doc/README.txt b/doc/README.txt index 97387d2..792b0f0 100644 --- a/doc/README.txt +++ b/doc/README.txt @@ -1,4 +1,5 @@ -SemanticScuttle 0.94 +==================== +SemanticScuttle 0.98 ==================== A social bookmarking tool experimenting with new features like structured tags or collaborative descriptions of tags. @@ -9,83 +10,58 @@ Available under the GNU General Public License Installation ------------- -See INSTALL.txt +============ +See `INSTALL.txt`__ + + +__ INSTALL.html Upgrading from a previous version ---------------------------------- -See UPGRADE.txt +================================= +See `UPGRADE.txt`__ + +__ UPGRADE.html Public API ----------- -Scuttle supports most of the del.icio.us API [1]. +========== +Scuttle supports most of the `del.icio.us API`__. Almost all of the neat tools made for that system can be modified to work with your SemanticScuttle installation. If you find a tool that won't let you change the API address, ask the creator to add this setting. You never know, they might just do it. -[1] http://del.icio.us/doc/api +__ http://del.icio.us/doc/api -Translations ------------- -Scuttle is available in the following languages : - -English en-GB 100% (Default) -Chinese zh-CN 86% -Danish dk-DK 100% -Dutch nl-NL 68% -French fr-FR 100% -German de-DE 100% -Hindi hi-IN 100% -Italian it-IT 89% -Japanese ja-JP 100% -Lithuanian lt-LT 100% -Portuguese pt-BR 100% -Spanish es-ES 94% - -Translations are managed with gettext . - -To provide additional translations: -- execute of of the scripts in - for example to complete french (France) translation on a - GNU/Linux system, type - ./gettexts.sh fr_FR -- then edit the file - with poedit - (that will update ) - Links ----- -http://semanticscuttle.wiki.sourceforge.net/ - - further documentation +- `further documentation`__ +- `support and help questions`__ +- `development mailing list instructions`__ +- `suggestions`_ for SemanticScuttle +- `bug reports`_ +- `feature requests`_ +- `patches`_ -http://sourceforge.net/forum/forum.php?forum_id=759510 - - support and help questions +__ http://semanticscuttle.wiki.sourceforge.net/ +__ http://sourceforge.net/forum/forum.php?forum_id=759510 +__ https://sourceforge.net/mailarchive/forum.php?forum_name=semanticscuttle-devel +.. _suggestions: http://sourceforge.net/forum/forum.php?forum_id=759511 +.. _bug reports: http://sourceforge.net/tracker/?group_id=211356&atid=1017430 +.. _feature requests: https://sourceforge.net/tracker/?group_id=211356&atid=1017433 +.. _patches: https://sourceforge.net/tracker/?group_id=211356&atid=1017432 -https://sourceforge.net/mailarchive/forum.php?forum_name=semanticscuttle-devel - - development mailing list instructions -http://sourceforge.net/forum/forum.php?forum_id=759511 - - suggestions for SemanticScuttle - -http://sourceforge.net/tracker/?group_id=211356&atid=1017430 - - bug reports - -https://sourceforge.net/tracker/?group_id=211356&atid=1017433 - - feature requests - -https://sourceforge.net/tracker/?group_id=211356&atid=1017432 - - patches Known issues ------------- +============ Number of bookmarks always 0: "0 bookmark(s)" - This issue occurs when debug mode is enabled. - Technically, this is because the database layers DEBUG_EXTRA gets - enabled through debug mode. +--------------------------------------------- +This issue occurs when debug mode is enabled. +Technically, this is because the database layers ``DEBUG_EXTRA`` gets +enabled through debug mode.