Updated READMEs, etc.
authorLee Daniel Crocker <lcrocker@users.mediawiki.org>
Thu, 17 Apr 2003 18:45:28 +0000 (18:45 +0000)
committerLee Daniel Crocker <lcrocker@users.mediawiki.org>
Thu, 17 Apr 2003 18:45:28 +0000 (18:45 +0000)
INSTALL
README
testsuite/README

diff --git a/INSTALL b/INSTALL
index f4d5e2d..85c63e2 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,3 +1,7 @@
+----
+Installing Wikipedia Phase III Software
+----
+
 The Wikipedia software was developed collabortively by
 many people, so it's something of a hodgepodge. The
 main wiki software itself is written in PHP, and requires
@@ -18,13 +22,40 @@ static binaries. TeTeX and ImageMagick are required at
 runtime, and ImageMagick requires GhostScript. These are
 present in most Linux distributions.
 
+----
+Scripts install.php and update.php
+----
+
 Before installing the software, you must copy the file
 "LocalSettings.sample" to "LocalSettings.php", and
 "AdminSettings.sample" to "AdminSettings.php", and
 customize both of the php files to your local setup
 (things like installation parh, passwords, etc.) The
-script install.php in the maintenance directory can then
-be run to install the software.
+script install.php can then be run to install the
+software. It must be run from the command line with
+PHP: that is, type "php install.php" (you may need to
+specify the path the php executable). You will probably
+need to run as root.
+
+This script will copy all the necessary software over to
+the directories you have specified in the settings files.
+It will then warn you that it is about to create the
+database and give you the chance to exit. If you are
+installing the software to an existing database, you can
+answer "no" here and it will be left alone. The software
+installation will be otherwise complete. If you do choose
+to create a new database, you will need te root password
+to your MySQL installation.
+
+If you are merely updating an existing installation, run
+"php update.php" instead of install.  This will copy all
+the software, and also run any dtabase updates that may
+be necessary. These should give appropriate warnings if
+there are any dangerous ones.
+
+----
+Building from scratch
+----
 
 Here are some more notes on building a system from scratch
 the way it was done for the Wikipedia server:
@@ -128,9 +159,9 @@ And for math support:
   You'll need to compile the texvc helper script; enter the math
   subdirectory of the source tree and run "make".
 
-  If you don't want embedded TeX support, disable it by setting
+  If you want embedded TeX support, enable it by setting
 
-   $wgUseTex = false;
+   $wgUseTex = true;
 
   in LocalSettings.php
 
diff --git a/README b/README
index 9b0fbde..79cf1b9 100644 (file)
--- a/README
+++ b/README
@@ -9,30 +9,31 @@ Wikipedia project. There are many good general-purpose Wikis
 in the world. I personally recommend UseMod
 (http://www.usemod.com/).
 
-The code as a whole is Copyright 2002-3 by Lee Daniel Crocker,
-Magnus Manske, Jan Hidders, Brion Vibber, Axel Boldt,
-Geoffrey T. Dairiki, Tomasz Wegrzanowski, and others,
-licensed under the terms of the GNU General Public License,
-version 2 (see http://www.fsf.org/licenses/gpl.html).
-Derivative works and later versions of the code will also be
-considered free software licensed under the same terms.
-
-Many thanks to the Wikipedia regulars for testing and
-suggestions.
+The code as a whole is Copyright 2002,2003 by
+Lee Daniel Crocker, Magnus Manske, Jan Hidders, Brion Vibber,
+Axel Boldt, Geoffrey T. Dairiki, Tomasz Wegrzanowski, and
+others, licensed under the terms of the
+GNU General Public License, version 2 (see
+http://www.fsf.org/licenses/gpl.html). Derivative works and
+later versions of the code will also be considered free
+software licensed under the same terms.
 
 Sections of code written exclusively by Lee Crocker are also
 released into the public domain, wich does not impair the
 obligations of users under the GPL for use of the whole code
 or other sections thereof.
 
+Many thanks to the Wikipedia regulars for testing and
+suggestions.
+
 The code is currently maintained at Sourceforge under the
-project "wikipedia", module name "phase3".  You can view the
+project "wikipedia", module name "phase3". You can view the
 code in CVS, report bugs and make feature requests there:
 
   http://wikipedia.sourceforge.net
 
 The code is written in PHP. It was tested mainly on version
-4.06, but it is known to run in later versions.  I requires
+4.06, but it is known to run in later versions. It requires
 MySQL 3.23 or later, and PHP-MySQL. It is now running with
 PHP 4.2.2 and MySQL 3.23.49 at http://www.wikipedia.org .
 The code was written on and for Linux, and no attempt has
index e3baa5f..610528f 100644 (file)
@@ -5,9 +5,11 @@ jars in the jars directory need to be in your classpath
 for compiling and running (it may require others as
 well depending on your JVM, but if you're a Java coder
 you know about all that). Apache's "ant" tool is used
-for building.
+for building (http://ant.apache.org/).
 
-I'm personally using generic Sun JDK 1.4 for Linux.
+I'm personally using generic Sun JDK 1.4 for Linux,
+though other 1.4-level VMs should work (or earlier
+ones with the addition of things like java.util.regex).
 
 --Lee Daniel Crocker <lee@piclab.com>
 March 4, 2003