]> gitweb.fluxo.info Git - semanticscuttle.git/commitdiff
make readme proper rST
authorChristian Weiske <cweiske@cweiske.de>
Thu, 26 May 2011 20:00:08 +0000 (22:00 +0200)
committerChristian Weiske <cweiske@cweiske.de>
Thu, 26 May 2011 20:00:08 +0000 (22:00 +0200)
doc/README.txt

index 97387d28a8d06ec76a46356d1532ffc85974125e..792b0f0daf626b33f5cba13fd1a482bcc27ec876 100644 (file)
@@ -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
-
-
-Translations
-------------
-Scuttle is available in the following languages :
+__ http://del.icio.us/doc/api
 
-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 <includes/php-gettext>.
-
-To provide additional translations:
-- execute of of the scripts in <includes/php-gettext/bin/>
-  for example to complete french (France) translation on a
-  GNU/Linux system, type
-  ./gettexts.sh fr_FR
-- then edit the file <locales/fr_FR/LC_MESSAGES/messages.po>
-  with poedit
-  (that will update <locales/fr_FR/LC_MESSAGES/messages.mo>)
 
 
 Links
 -----
-http://semanticscuttle.wiki.sourceforge.net/
- - further documentation
-
-http://sourceforge.net/forum/forum.php?forum_id=759510
- - support and help questions
-
-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
+- `further documentation`__
+- `support and help questions`__
+- `development mailing list instructions`__
+- `suggestions`_ for SemanticScuttle
+- `bug reports`_
+- `feature requests`_
+- `patches`_
 
-http://sourceforge.net/tracker/?group_id=211356&atid=1017430
- - bug reports
+__ 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/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.