Changed "Open PHP Declarartion" action in the PHP editor:

[phpeclipse.git] / net.sourceforge.phpeclipse / install.txt

diff --git a/net.sourceforge.phpeclipse/install.txt b/net.sourceforge.phpeclipse/install.txt
index d00dde2..01cbc73 100644 (file)
--- a/net.sourceforge.phpeclipse/install.txt
+++ b/net.sourceforge.phpeclipse/install.txt
@@ -1,27 +1,41 @@
 PHPEclipse  Version 1.0.6alpha
 Copyright 2003 net.sourceforge.phpeclipse
+http://www.phpeclipse.org
 Contributors:
-       Klaus Hartlage
-       Matthieu Casanova
-       Le Borgne Cédric
-       David Cummings
-       Thomas Geiger
-       Rusell Wilson
-       Philippe Lachaise 
-       Stefan Langer
-       and others...
-       
+    Klaus Hartlage
+    Matthieu Casanova
+    Le Borgne Cédric
+    David Cummings
+    Thomas Geiger
+    Rusell Wilson
+    Philippe Lachaise
+    Stefan Langer
+    and others...
+
 This Plugin is released under the Common Public License v1.0 which is included
 in this distribution or can be viewed at http://www.eclipse.org/legal/cpl-v10.html.
 
-Look for updated versions of this plugin at http://phpeclipse.sourceforge.net
+Look for updated versions of this plugin at http://www.phpeclipse.org -> Downloads
+
+1. Requirements
+2. Recommended
+3. Installation
+4. Editing PHP
+5. Additional Help
+6. Additional Plugins
+7. Contributing
+    7.1 Reporting Bugs
+
 
- Requirements
+
+ 1. Requirements
 ------------------------------------------
-Eclipse 2.x or higher (downloadable at http://www.eclipse.org)
+Java Runtime 1.4.x or higher ( downloadable at http://java.sun.com )
+Eclipse 2.1 or higher ( downloadable at http://www.eclipse.org )
+
 
 
- Recommended
+ 2. Recommended
 ------------------------------------------
 PHP Enviroment for running PHP code.
 PHP can be downloaded at http://www.php.net
@@ -29,7 +43,8 @@ Server can be found at http://httpd.apache.org
 MySQL can be found at http://www.mysql.org
 
 
- Installation
+
+ 3. Installation
 ------------------------------------------
 Simply unzip the files to your eclipse plugins directory and (re)start eclipse.
 (<eclipse-install>/plugins/)
@@ -44,16 +59,16 @@ After installation the directorystructure should look as follows:
 .     plugins
 .           |
 .           |
-            |- net.sourceforge.phpeclipse           // plugin folder
+            |- net.sourceforge.phpeclipse_x.x.x     // plugin folder
             |               |
             .               |
             .               |-- phpeclipse.jar      // the plugin jar file
             .               |
-                            |-- plugin.xml
+                            |-- plugin.xml          // plugin manifest
                             |
-                            |-- plugin.properties
+                            |-- plugin.properties   // manifest properties
                             |
-                            |-- phpeclipsesrc.zip   // sources for phpeclipse
+                            |-- phpeclipsesrc.zip   // sources for phpeclipse (if you don't need the sources you can safly delete this file)
                             |
                             |-- install.txt         // this textfile
                             |
@@ -62,24 +77,64 @@ After installation the directorystructure should look as follows:
                             |-- TODO                // what's to do
 
 
- Editing PHP
+ 4. Editing PHP
 ------------------------------------------
 To start coding your php code. Simply create a new project.
 (File -> New... -> Project) And choose PHP from the left list.
 Choose PHP Project from the right and press "Next >".
 Specify a name for your project and press "Finish".
 
-The PHP Perspective should open and you can add new PHP files.
+To open the PHP Perspective click Windows -> Open Perspective -> Other... and
+choose PHP from the list.
 
 - For more Information go to the menu "Help->Help Contents" and
   open the "PHPEclipse Help"
 
 
 
-Additional Plugins for PHPEclipse
+ 5. Additional Help
+------------------------------------------
+There is a help forum at http://sourceforge.net/projects/phpeclipse.
+Just follow the "Forums" link.
+
+
+
+ 6. Additional Plugins for PHPEclipse
 ------------------------------------------
 
-- PHPEclipse SQL Plugin
-- PHPEclipse JTidy Plugin
+- PHPEclipse SQL Plugin : Helps create SQL statements
+- PHPEclipse JTidy Plugin : Checks and cleans up HTML.
 
 Both can be found at: http://sourceforge.net/projects/phpeclipse/
+
+
+
+ 7. Contributing
+------------------------------------------
+To make PHPEclipse a usefull tool for developing PHP we need your help.
+No contribution is too small or too big!
+We need:
+    Developers
+    Documentation
+    Translation
+    Bundling
+    ...
+
+See http://phpeclipse.sourceforge.net/en/get_involved.php for more information
+on how to contribute.
+
+BUT MOST IMPORTANT we need your help to find and fix those little bugs that
+seem to creep into the code.
+
+
+ 7.1 Bug Reporting
+------------------------------------------
+Before reporting a bug make sure that you are using the latest release of
+PHPEclipse.
+
+If you find a bug see if it is allready listed in the bug database
+at http://sourceforge.net/projects/phpeclipse/ -> Bugs
+If it is not listed create a new bug report. Be sure to include your system
+information (e.g. W2K Pentium 4 512 MB RAM), your Eclipse version
+(e.g. Eclipse 2.1), the version of phpeclipse you are using and a detailed
+description of the bug and how it can be reproduced.