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