aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Weiske <cweiske@cweiske.de>2011-05-26 21:19:47 +0200
committerChristian Weiske <cweiske@cweiske.de>2011-05-26 21:19:47 +0200
commit2dc582cfbb9c317fc75343acf6c023df1b07b8a2 (patch)
treeb540a65382504bd6bf21ca82651a09cf6793318a
parentbb4b6574bc63e38cb39dffab90985228f1506d90 (diff)
downloadsemanticscuttle-2dc582cfbb9c317fc75343acf6c023df1b07b8a2.tar.gz
semanticscuttle-2dc582cfbb9c317fc75343acf6c023df1b07b8a2.tar.bz2
make INSTALL.txt file valid rST
-rw-r--r--doc/INSTALL.txt50
1 files changed, 31 insertions, 19 deletions
diff --git a/doc/INSTALL.txt b/doc/INSTALL.txt
index b2dd3b2..5afc732 100644
--- a/doc/INSTALL.txt
+++ b/doc/INSTALL.txt
@@ -1,51 +1,60 @@
+============================
SemanticScuttle installation
============================
Prerequisites
--------------
+=============
To run SemanticScuttle, you need:
+
- PHP5 with filter functions enabled
- A web server, for example Apache
Installation instructions
--------------------------
+=========================
1. Create a new MySQL database
-2. Import tables.sql into that database, i.e.
- run
- > mysql -umyusername semanticscuttle < data/tables.sql
+2. Import ``data/tables.sql`` into that database, i.e.
+ run ::
+
+ $ mysql -umyusername semanticscuttle < data/tables.sql
+
on the shell ("semanticscuttle" being the database name)
-3. Copy data/config.php.dist to data/config.php and modify it as
+
+3. Copy ``data/config.php.dist`` to ``data/config.php`` and modify it as
necessary.
4. Make the cache directory writable by your web server.
- For example, run
- > chmod 0777 cache
+ For example, run ::
+
+ $ chmod 0777 cache
+
on the shell.
-5. Set the www/ directory as document root in your web server,
+5. Set the ``www/`` directory as document root in your web server,
restart the web server.
Ugly www directory in URLs
---------------------------
+==========================
In case point 5 of the installation instructions cannot be put into
practice by you because you are not able to change the web server
configuration, you are not lost! There is a way to get rid of
-www/ in your URL!
+``www/`` in your URL!
+
+Imagine following directory layout: ::
-Imagine following directory layout:
/home/customer123/
www/
subdomain1/
subdomain2/
subdomain3/
-Create a SemanticScuttle directory somewhere outside www if possible
-and put all directories except www/ in there. Move all files and
-directories from www/ into your subdomain directory. Then modify
-subdomain/www-header.php to include the correct file path.
+Create a SemanticScuttle directory somewhere outside ``www`` if possible
+and put all directories except ``www/`` in there. Move all files and
+directories from ``www/`` into your subdomain directory. Then modify
+``subdomain/www-header.php`` to include the correct file path.
+
+The new directory layout should look that way: ::
-The new directory layout should look that way:
/home/customer123/
semanticscuttle/
doc/
@@ -60,8 +69,11 @@ The new directory layout should look that way:
www-header.php
subdomain3/
-Now open www-header.php and replace
+Now open www-header.php and replace ::
+
require_once '../src/SemanticScuttle/header.php';
-with
+
+with ::
+
require_once '../../semanticscuttle/src/SemanticScuttle/header.php';