First submit for debug plugin
[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
6     Matthieu Casanova
7     Le Borgne Cédric
8     David Cummings
9     Thomas Geiger
10     Rusell Wilson
11     Philippe Lachaise
12     Stefan Langer
13     and others...
14
15 This Plugin is released under the Common Public License v1.0 which is included
16 in this distribution or can be viewed at http://www.eclipse.org/legal/cpl-v10.html.
17
18 Look for updated versions of this plugin at http://www.phpeclipse.org -> Downloads
19
20 1. Requirements
21 2. Recommended
22 3. Installation
23 4. Editing PHP
24 5. Additional Help
25 6. Additional Plugins
26 7. Contributing
27     7.1 Reporting Bugs
28
29
30
31  1. Requirements
32 ------------------------------------------
33 Java Runtime 1.4.x or higher ( downloadable at http://java.sun.com )
34 Eclipse 2.1 or higher ( downloadable at http://www.eclipse.org )
35
36
37
38  2. Recommended
39 ------------------------------------------
40 PHP Enviroment for running PHP code.
41 PHP can be downloaded at http://www.php.net
42 Server can be found at http://httpd.apache.org
43 MySQL can be found at http://www.mysql.org
44
45
46
47  3. Installation
48 ------------------------------------------
49 Simply unzip the files to your eclipse plugins directory and (re)start eclipse.
50 (<eclipse-install>/plugins/)
51
52 If you copy the files manually make sure all files are located in the
53 net.sourceforge.phpeclipse folder in the plugins directory in your eclipse installation.
54
55 After installation the directorystructure should look as follows:
56
57 |--<eclipse install>
58 |     |
59 .     plugins
60 .           |
61 .           |
62             |- net.sourceforge.phpeclipse_x.x.x     // plugin folder
63             |               |
64             .               |
65             .               |-- phpeclipse.jar      // the plugin jar file
66             .               |
67                             |-- plugin.xml          // plugin manifest
68                             |
69                             |-- plugin.properties   // manifest properties
70                             |
71                             |-- phpeclipsesrc.zip   // sources for phpeclipse (if you don't need the sources you can safly delete this file)
72                             |
73                             |-- install.txt         // this textfile
74                             |
75                             |-- cpl-v10.html        // common public licence
76                             |
77                             |-- TODO                // what's to do
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 - For more Information go to the menu "Help->Help Contents" and
91   open the "PHPEclipse Help"
92
93
94
95  5. Additional Help
96 ------------------------------------------
97 There is a help forum at http://sourceforge.net/projects/phpeclipse.
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 - PHPEclipse JTidy Plugin : Checks and cleans up HTML.
107
108 Both can be found at: http://sourceforge.net/projects/phpeclipse/
109
110
111
112  7. Contributing
113 ------------------------------------------
114 To make PHPEclipse a usefull tool for developing PHP we need your help.
115 No contribution is too small or too big!
116 We need:
117     Developers
118     Documentation
119     Translation
120     Bundling
121     ...
122
123 See http://phpeclipse.sourceforge.net/en/get_involved.php for more information
124 on how to contribute.
125
126 BUT MOST IMPORTANT we need your help to find and fix those little bugs that
127 seem to creep into the code.
128
129
130  7.1 Bug Reporting
131 ------------------------------------------
132 Before reporting a bug make sure that you are using the latest release of
133 PHPEclipse.
134
135 If you find a bug see if it is allready listed in the bug database
136 at http://sourceforge.net/projects/phpeclipse/ -> Bugs
137 If it is not listed create a new bug report. Be sure to include your system
138 information (e.g. W2K Pentium 4 512 MB RAM), your Eclipse version
139 (e.g. Eclipse 2.1), the version of phpeclipse you are using and a detailed
140 description of the bug and how it can be reproduced.