Use ReST for README, UPGRADE and INSTALL documentation. Rewrite installation docs and readme
git-svn-id: https://semanticscuttle.svn.sourceforge.net/svnroot/semanticscuttle/trunk@353 b3834d28-1941-0410-a4f8-b48e95affb8f
This commit is contained in:
cweiske
parent
964e9c2148
commit
124979de99
4 changed files with 113 additions and 64 deletions
14
INSTALL.txt
Normal file
14
INSTALL.txt
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
SemanticScuttle installation
|
||||
============================
|
||||
|
||||
1. Create a new MySQL database
|
||||
2. Import tables.sql into that database, i.e.
|
||||
run
|
||||
> mysql -umyusername semanticscuttle < tables.sql
|
||||
on the shell ("semanticscuttle" being the database name)
|
||||
3. Copy config.inc.php.dist to config.php and modify it as
|
||||
necessary.
|
||||
4. Make the cache directory writable by your web server.
|
||||
For example, run
|
||||
> chmod 0777 cache
|
||||
on the shell.
|
||||
82
README.txt
Normal file
82
README.txt
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
SemanticScuttle
|
||||
===============
|
||||
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
|
||||
|
||||
|
||||
Upgrading from a previous version
|
||||
---------------------------------
|
||||
See UPGRADE.txt
|
||||
|
||||
|
||||
Public API
|
||||
----------
|
||||
Scuttle supports most of the del.icio.us API [1].
|
||||
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 :
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
|
@ -1,6 +1,9 @@
|
|||
==== UPGRADE instructions ====
|
||||
Upgrading SemanticScuttle from a previous version
|
||||
=================================================
|
||||
|
||||
From version 0.92 to 0.93
|
||||
-------------------------
|
||||
|
||||
=== From version 0.92 to 0.93 ===
|
||||
- Backup your database
|
||||
- Make a copy from your SemanticScuttle Web directory
|
||||
- Upgrade your database by following instructions ONE after ONE (order is important) :
|
||||
|
|
@ -14,8 +17,8 @@ $adminsAreAdvisedTagsFromOtherAdmins = false; # 'true' if tags from other admin
|
|||
$defaultPerPageForAdmins = 20; # default number of bookmarks per page for admins (-1 means no limit)
|
||||
|
||||
|
||||
|
||||
=== From version 0.91 to 0.92 ===
|
||||
From version 0.91 to 0.92
|
||||
-------------------------
|
||||
Message: this version modifies the database to UTF-8 charset. The idea is to convert the content (through BLOB type) and then to change the tables' charsets.
|
||||
|
||||
- Backup your database
|
||||
|
|
@ -113,7 +116,9 @@ ALTER TABLE `sc_searchhistory` CHARACTER SET utf8 COLLATE utf8_general_ci;
|
|||
* Add variable : $enableCommonTagDescriptionEditedByAll = true; #true mean everybody can edit common description. Else just the admins can do it.
|
||||
* Add variable : $googleAnalyticsCode = ''; #Allow GoogleAnalytics tracker https://www.google.com/analytics/
|
||||
|
||||
=== From version 0.90 to 0.91 ===
|
||||
|
||||
From version 0.90 to 0.91
|
||||
-------------------------
|
||||
- Backup you database
|
||||
- Make a copy from your SemanticScuttle Web directory
|
||||
- Upgrade your database by following instructions ONE after ONE (order is important) :
|
||||
|
|
@ -132,7 +137,10 @@ ALTER TABLE `sc_searchhistory` CHARACTER SET utf8 COLLATE utf8_general_ci;
|
|||
* Add variable: $menu2Tags = array('example', 'of', 'menu', 'tags');
|
||||
* Add variable: $debugMode = true; # if true, show debug messages
|
||||
|
||||
=== From version 0.89 to 0.90 ===
|
||||
|
||||
From version 0.89 to 0.90
|
||||
-------------------------
|
||||
|
||||
- Backup you database
|
||||
- Make a copy from your SemanticScuttle Web directory
|
||||
|
||||
|
|
@ -143,7 +151,9 @@ $thumbnailsKey = '';
|
|||
|
||||
|
||||
|
||||
=== From version 0.88 to 0.89 ===
|
||||
From version 0.88 to 0.89
|
||||
-------------------------
|
||||
|
||||
- Backup you database
|
||||
- Make a copy from your SemanticScuttle Web directory
|
||||
- Upgrade your database by following instructions ONE after ONE (order is important) :
|
||||
|
|
@ -182,5 +192,3 @@ $thumbnailsKey = '';
|
|||
$index_sidebar_blocks = array('search','menu','users','popular');
|
||||
# add line:
|
||||
$enableGoogleCustomSearch = true;
|
||||
|
||||
|
||||
55
readme.txt
55
readme.txt
|
|
@ -1,55 +0,0 @@
|
|||
SemanticScuttle
|
||||
https://sourceforge.net/projects/semanticscuttle/
|
||||
|
||||
Copyright (C) 2007 SemanticScuttle project
|
||||
Available under the GNU General Public License
|
||||
|
||||
= INSTALL =
|
||||
- Execute the SQL contained in tables.sql to create the necessary database tables. This file was written specifically for MySQL, so may need rewritten if you intend to use a different database system.
|
||||
- Edit config.inc.php.example and save the changes as a new config.inc.php file in the same directory.
|
||||
- Set the CHMOD permissions on the /cache/ subdirectory to 777
|
||||
|
||||
= UPGRADE =
|
||||
See ./upgrade.txt
|
||||
|
||||
= Use API =
|
||||
Scuttle supports most of the del.icio.us API [ http://del.icio.us/doc/api ]. Almost all of the neat tools made for that system can be modified to work with your installation instead. 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.
|
||||
|
||||
= TRANSLATE =
|
||||
Scuttle is available in the folowing 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%
|
||||
|
||||
Translation is 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, 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 =
|
||||
For further documentation, read http://semanticscuttle.wiki.sourceforge.net/
|
||||
|
||||
If you need help, post to http://sourceforge.net/forum/forum.php?forum_id=759510
|
||||
|
||||
Suggestions are welcome on http://sourceforge.net/forum/forum.php?forum_id=759511
|
||||
|
||||
Bug reports:
|
||||
http://sourceforge.net/tracker/?group_id=211356&atid=1017430
|
||||
|
||||
Feature requests:
|
||||
|
||||
User-submitted patches:
|
||||
|
||||
Discussion forum:
|
||||
Loading…
Reference in a new issue