Changed gather.bin target to include all resources
[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 Eclipse 2.1 or higher (downloadable at http://www.eclipse.org)
34
35
36
37  2. Recommended
38 ------------------------------------------
39 PHP Enviroment for running PHP code.
40 PHP can be downloaded at http://www.php.net
41 Server can be found at http://httpd.apache.org
42 MySQL can be found at http://www.mysql.org
43
44
45
46  3. Installation
47 ------------------------------------------
48 Simply unzip the files to your eclipse plugins directory and (re)start eclipse.
49 (<eclipse-install>/plugins/)
50
51 If you copy the files manually make sure all files are located in the
52 net.sourceforge.phpeclipse folder in the plugins directory in your eclipse installation.
53
54 After installation the directorystructure should look as follows:
55
56 |--<eclipse install>
57 |     |
58 .     plugins
59 .           |
60 .           |
61             |- net.sourceforge.phpeclipse_x.x.x     // plugin folder
62             |               |
63             .               |
64             .               |-- phpeclipse.jar      // the plugin jar file
65             .               |
66                             |-- plugin.xml          // plugin manifest
67                             |
68                             |-- plugin.properties   // manifest properties
69                             |
70                             |-- phpeclipsesrc.zip   // sources for phpeclipse (if you don't need the sources you can safly delete this file)
71                             |
72                             |-- install.txt         // this textfile
73                             |
74                             |-- cpl-v10.html        // common public licence
75                             |
76                             |-- TODO                // what's to do
77
78
79  4. Editing PHP
80 ------------------------------------------
81 To start coding your php code. Simply create a new project.
82 (File -> New... -> Project) And choose PHP from the left list.
83 Choose PHP Project from the right and press "Next >".
84 Specify a name for your project and press "Finish".
85
86 To open the PHP Perspective click Windows -> Open Perspective -> Other... and
87 choose PHP from the list.
88
89 - For more Information go to the menu "Help->Help Contents" and
90   open the "PHPEclipse Help"
91
92
93
94  5. Additional Help
95 ------------------------------------------
96 There is a help forum at http://sourceforge.net/projects/phpeclipse.
97 Just follow the "Forums" link.
98
99
100
101  6. Additional Plugins for PHPEclipse
102 ------------------------------------------
103
104 - PHPEclipse SQL Plugin : Helps create SQL statements
105 - PHPEclipse JTidy Plugin : Checks and cleans up HTML.
106
107 Both can be found at: http://sourceforge.net/projects/phpeclipse/
108
109
110
111  7. Contributing
112 ------------------------------------------
113 To make PHPEclipse a usefull 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 See http://phpeclipse.sourceforge.net/en/get_involved.php for more information
123 on how to contribute.
124
125 BUT MOST IMPORTANT we need your help to find and fix those little bugs that
126 seem to creep into the code.
127
128
129  7.1 Bug Reporting
130 ------------------------------------------
131 Before reporting a bug make sure that you are using the latest release of
132 PHPEclipse.
133
134 If you find a bug see if it is allready listed in the bug database
135 at http://sourceforge.net/projects/phpeclipse/ -> Bugs
136 If it is not listed create a new bug report. Be sure to include your system
137 information (e.g. W2K Pentium 4 512 MB RAM), your Eclipse version
138 (e.g. Eclipse 2.1), the version of phpeclipse you are using and a detailed
139 description of the bug and how it can be reproduced.