new SF update site
[phpeclipse.git] / net.sourceforge.phpeclipse / install.txt
1 PHPEclipse  Version 1.1.0
2 Copyright 2003-2004 net.sourceforge.phpeclipse
3 http://www.phpeclipse.org
4 Contributors:
5     Axel Kramer (http://www.phpeclipse.de)
6     Fernando Vicente
7     Christian Perkonig
8     Matthieu Casanova
9            Le Borgne C�dric
10     David Cummings
11     Thomas Geiger
12     Rusell Wilson
13     Philippe Lachaise
14     Stefan Langer
15     Bastien Durel
16     
17     and others...
18
19 This Plugin is released under the Common Public License v1.0 which is included
20 in this distribution or can be viewed at http://www.eclipse.org/legal/cpl-v10.html.
21
22 Look for updated versions of this plugin at http://www.phpeclipse.de -> Install/Downloads
23
24 1. Requirements
25 2. Recommended
26 3. Installation
27 4. Editing PHP
28 5. Additional Help
29 6. Additional Plugins
30 7. Contributing
31     7.1 Reporting Bugs
32
33
34
35  1. Requirements
36 ------------------------------------------
37 Java Runtime 1.4.x or higher ( downloadable at http://java.sun.com )
38 Eclipse 3.0 or higher ( downloadable at http://www.eclipse.org )
39
40
41
42  2. Recommended
43 ------------------------------------------
44 PHP Enviroment for running PHP code.
45 PHP can be downloaded at http://www.php.net
46 Server can be found at http://httpd.apache.org
47 MySQL can be found at http://www.mysql.org
48
49
50
51  3. Installation
52 ------------------------------------------
53 Simply unzip the files to your eclipse plugins directory and (re)start eclipse.
54 (<eclipse-install>/plugins/)
55
56 If you copy the files manually make sure all files are located in the
57 net.sourceforge.phpeclipse folder in the plugins directory in your eclipse installation.
58
59 After installation the directorystructure should look as follows (example):
60
61 |--<eclipse install>
62 |     |
63 .     plugins
64 .           |
65 .           |
66             |- net.sourceforge.phpeclipse_x.x.x     // plugin folder
67             |               |
68             .               |
69             .               |-- phpeclipse.jar      // the plugin jar file
70             .               |
71                             |-- plugin.xml          // plugin manifest
72                             |
73                             |-- plugin.properties   // manifest properties
74                             |
75                             |-- phpeclipsesrc.zip   // sources for phpeclipse (if you don't need the sources you can safly delete this file)
76                             |
77                             |-- install.txt         // this textfile
78                             |
79                             |-- cpl-v10.html        // common public licence
80                             |
81                             |-- icons               // Icons directory 
82
83
84  4. Editing PHP
85 ------------------------------------------
86 To start coding your php code. Simply create a new project.
87 (File -> New... -> Project) And choose PHP from the left list.
88 Choose PHP Project from the right and press "Next >".
89 Specify a name for your project and press "Finish".
90
91 To open the PHP Perspective click Windows -> Open Perspective -> Other... and
92 choose PHP from the list.
93
94
95  5. Additional Help
96 ------------------------------------------
97 There is a help forum at http://www.phpeclipse.de.
98 Just follow the "Forums" link.
99
100
101
102  6. Additional Plugins for PHPEclipse
103 ------------------------------------------
104
105 - PHPEclipse SQL Plugin : Helps create SQL statements
106
107 Both can be found at: http://sourceforge.net/projects/phpeclipse/
108
109
110
111  7. Contributing
112 ------------------------------------------
113 To make PHPEclipse a useful tool for developing PHP we need your help.
114 No contribution is too small or too big!
115 We need:
116     Developers
117     Documentation
118     Translation
119     Bundling
120     ...
121
122
123 BUT MOST IMPORTANT we need your help to find and fix those little bugs that
124 seem to creep into the code.
125
126
127  7.1 Bug Reporting
128 ------------------------------------------
129 Before reporting a bug make sure that you are using the latest release of
130 PHPEclipse.
131
132 If you find a bug see if it is allready listed in the bug database
133 at http://sourceforge.net/projects/phpeclipse/ -> Bugs
134 If it is not listed create a new bug report. Be sure to include your system
135 information (e.g. W2K Pentium 4 512 MB RAM), your Eclipse version
136 (e.g. Eclipse 3.0), the version of phpeclipse you are using and a detailed
137 description of the bug and how it can be reproduced.