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