From d2e4df06c3ed2ec3b84025c89342c0d937f44ffe Mon Sep 17 00:00:00 2001 From: Christian Weiske Date: Thu, 26 May 2011 22:00:41 +0200 Subject: move readme.txt to rst --- doc/README.rst | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 doc/README.rst (limited to 'doc/README.rst') diff --git a/doc/README.rst b/doc/README.rst new file mode 100644 index 0000000..792b0f0 --- /dev/null +++ b/doc/README.rst @@ -0,0 +1,67 @@ +==================== +SemanticScuttle 0.98 +==================== +A social bookmarking tool experimenting with new features +like structured tags or collaborative descriptions of tags. + +https://sourceforge.net/projects/semanticscuttle/ + +Available under the GNU General Public License + + +Installation +============ +See `INSTALL.txt`__ + + +__ INSTALL.html + + +Upgrading from a previous version +================================= +See `UPGRADE.txt`__ + +__ UPGRADE.html + + +Public API +========== +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. + +__ http://del.icio.us/doc/api + + + +Links +----- +- `further documentation`__ +- `support and help questions`__ +- `development mailing list instructions`__ +- `suggestions`_ for SemanticScuttle +- `bug reports`_ +- `feature requests`_ +- `patches`_ + +__ 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 + + + + +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. -- cgit v1.2.3 From fa64fb2a4984e9f1a14e02916854472ba0a4637f Mon Sep 17 00:00:00 2001 From: Christian Weiske Date: Thu, 26 May 2011 22:01:45 +0200 Subject: fix file name --- doc/README.rst | 2 +- doc/UPGRADE.txt | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) (limited to 'doc/README.rst') diff --git a/doc/README.rst b/doc/README.rst index 792b0f0..6cfe270 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -11,7 +11,7 @@ Available under the GNU General Public License Installation ============ -See `INSTALL.txt`__ +See `INSTALL.rst`__ __ INSTALL.html diff --git a/doc/UPGRADE.txt b/doc/UPGRADE.txt index 3be6654..2d4c4d2 100644 --- a/doc/UPGRADE.txt +++ b/doc/UPGRADE.txt @@ -1,3 +1,4 @@ +================================================= Upgrading SemanticScuttle from a previous version ================================================= -- cgit v1.2.3 From 628260297a181a974d369cf72f8c59c9ff155e00 Mon Sep 17 00:00:00 2001 From: Christian Weiske Date: Thu, 26 May 2011 22:02:40 +0200 Subject: fix name --- doc/README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/README.rst') diff --git a/doc/README.rst b/doc/README.rst index 6cfe270..0c7befe 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -26,7 +26,7 @@ __ UPGRADE.html Public API ========== -Scuttle supports most of the `del.icio.us API`__. +SemanticScuttle 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 -- cgit v1.2.3