Mercurial Repositories > eric / file comparison
comparison: README
README
- changeset 4266
- 17c215c416ba
- parent 4263
- 7c7cb5188773
- child 4267
- 94496d77156b
equal
deleted
inserted
replaced
| 4263:7c7cb5188773 | 4266:17c215c416ba |
|---|---|
| 1 README for the eric6 IDE | |
| 2 | |
| 3 Installation | |
| 4 | |
| 5 Installing eric6 is a simple process. Just execute the install.py script | |
| 6 (type python install.py -h for some help). Please note that the installation | |
| 7 has to be performed using the administrators account (i.e. root on linux). | |
| 8 This installs a wrapper script in the standard executable directory called | |
| 9 eric6. | |
| 10 | |
| 11 If you want to uninstall the package just execute the uninstall script. This | |
| 12 gets rid of all installed files. In this case please send an email to the | |
| 13 below mentioned address and tell me your reason. This might give me a hint on | |
| 14 how to improve eric6. | |
| 15 | |
| 16 If the required packages (Qt5, QScintilla2, sip and PyQt5) are not installed, | |
| 17 please get them and install them in the following order (order is important). | |
| 18 | |
| 19 1. Install Qt5 (from Nokia) | |
| 20 | |
| 21 2. Build and install QScintilla2 (from Riverbank Computing) | |
| 22 | |
| 23 3. Build and install sip (from Riverbank Computing) | |
| 24 | |
| 25 4. Build and install PyQt5 (from Riverbank Computing) | |
| 26 | |
| 27 5. Build and install QScintilla2 Python bindings | |
| 28 (part of the QScintilla2 package) | |
| 29 | |
| 30 6. Install eric6 | |
| 31 | |
| 32 If you want to use the interfaces to other supported software packages, you may | |
| 33 install them in any order and at any time. | |
| 34 | |
| 35 Please note, that the QScintilla2 Python bindings have to be rebuild, if | |
| 36 the PyQt5 package gets updated. If this step is omitted, a bunch of strange | |
| 37 errors will occur. | |
| 38 | |
| 39 Installation of translations | |
| 40 | |
| 41 Translations of the eric6 IDE are available as separate downloads. There | |
| 42 are two ways to install them. | |
| 43 | |
| 44 The first possibility is to install them together with eric6. In order | |
| 45 to do that, simply extract the downloaded archives into the same place | |
| 46 as the eric6 archive and follow the installation instructions above. | |
| 47 | |
| 48 The second possibility is to install them separately. Extract the | |
| 49 downloaded archives and execute the install-i18n.py script (type | |
| 50 python install-i18n.py -h for some help). This way you can make the | |
| 51 translations available to everybody or just to the user executing the | |
| 52 installation command (if using the -p switch). | |
| 53 | |
| 54 Running | |
| 55 | |
| 56 Just call up eric6, which will start the IDE. Use the "what is"-help | |
| 57 (arrow with ?) to get some help. Sorry, there is no documentation yet. | |
| 58 To start the unit test module in a standalone variant simply call up | |
| 59 eric6-unittest. This will show the same dialog (though with a little bit less | |
| 60 functionality) as if started from within eric6. The helpviewer can be | |
| 61 started as a standalone program by executing the eric6-webbrowser script. | |
| 62 | |
| 63 Please note, the first time you start eric6 it will recognize, that it | |
| 64 hasn't been configured yet and will show the configuration dialog. | |
| 65 Please take your time and go through all the configuration items. | |
| 66 However, every configuration option has a meaningful default value. | |
| 67 | |
| 68 Running from the sources | |
| 69 | |
| 70 If you want to run eric6 from within the source tree you have to execute | |
| 71 the compileUiFiles.py script once after a fresh checkout from the source | |
| 72 repository or when new dialogs have been added. Thereafter just execute | |
| 73 the eric6.py script. | |
| 74 | |
| 75 Tray starter | |
| 76 | |
| 77 eric6 comes with a little utility called "eric6-tray". This embeds an icon | |
| 78 in the system tray, which contains a context menu to start eric6 and all | |
| 79 it's utilities. Double clicking this icon starts the eric6 IDE. | |
| 80 | |
| 81 Autocompletion/Calltips | |
| 82 | |
| 83 eric6 provides an interface to the QScintilla auto-completion and calltips | |
| 84 functionality. QScintilla2 comes with API files for Python and itself. PyQt4 | |
| 85 contains an API file as well. These are installed by default, if the correct | |
| 86 installation order (see above) is followed. An API file for eric6 is | |
| 87 installed in the same place. | |
| 88 | |
| 89 In order to use autocompletion and calltips in eric6 please configure these | |
| 90 functions in the "Preferences Dialog" on the "Editor -> APIs", | |
| 91 "Editor -> Autocompletion" and "Editor -> Calltips" pages. | |
| 92 | |
| 93 Remote Debugger | |
| 94 | |
| 95 In order to enable the remote debugger start eric6, open the preferences | |
| 96 dialog and configure the settings on the debugger pages. | |
| 97 | |
| 98 The remote login must be possible without any further interaction (i.e. | |
| 99 no password prompt). If the remote setup differs from the local one you | |
| 100 must configure the Python interpreter and the Debug Client to be used | |
| 101 in the Preferences dialog. eric6 includes two different versions of the | |
| 102 debug client. DebugClient.py is the traditional debugger and | |
| 103 DebugClientThreads is a multithreading variant of the debug client. | |
| 104 Please copy all needed files to a place accessible through the Python path | |
| 105 of the remote machine and set the entries of the a.m. configuration tab | |
| 106 accordingly. | |
| 107 | |
| 108 Passive Debugging | |
| 109 | |
| 110 Passive debugging mode allows the startup of the debugger from outside | |
| 111 of the IDE. The IDE waits for a connection attempt. For further details | |
| 112 see the file README-passive-debugging.txt | |
| 113 | |
| 114 Plugin System | |
| 115 | |
| 116 eric6 contains a plugin system, that is used to extend eric6's | |
| 117 functionality. Some plugins are part of eric6. Additional plugins | |
| 118 are available via the Internet. Please use the built in plug-in | |
| 119 repository dialog to get a list of available (official) plugins | |
| 120 and to download them. For more details about the plug-in system | |
| 121 please see the documentation area. | |
| 122 | |
| 123 Interfaces to additional software packages | |
| 124 | |
| 125 At the moment eric6 provides interfaces to the following software | |
| 126 packages. | |
| 127 | |
| 128 Qt-Designer | |
| 129 This is part of the Qt distribution and is used to generate user | |
| 130 interfaces. | |
| 131 | |
| 132 Qt-Linguist | |
| 133 This is part of the Qt distribution and is used to generate translations. | |
| 134 | |
| 135 Qt-Assistant | |
| 136 This is part of the Qt distribution and may be used to display help files. | |
| 137 | |
| 138 Mercurial | |
| 139 This is a distributed version control system available from | |
| 140 <mercurial.selenic.com>. It is the one used by eric6 itself. | |
| 141 | |
| 142 Subversion | |
| 143 This is a version control system available from <subversion.apache.org>. | |
| 144 eric6 supports two different Subversion interfaces. One is using | |
| 145 the svn command line tool, the other is using the PySvn Python | |
| 146 interface <pysvn.tigris.org>. The selection is done automatically | |
| 147 depending on the installed software. The PySvn interface is prefered. | |
| 148 This automatism can be overridden an a per project basis using | |
| 149 the "User Properties" dialog. | |
| 150 | |
| 151 coverage.py | |
| 152 This is a tool to check Python code coverage. A slightly modified | |
| 153 version is part of the eric6 distribution. The original version is | |
| 154 available from <www.nedbatchelder.com/code/modules/coverage.html> | |
| 155 | |
| 156 tabnanny | |
| 157 This is a tool to check Python code for white-space related problems. It | |
| 158 is part of the standard Python installation. | |
| 159 | |
| 160 profile | |
| 161 This is part of the standard Python distribution and is used to profile | |
| 162 Python source code. | |
| 163 | |
| 164 Internationalization | |
| 165 | |
| 166 eric6 and it's tools are prepared to show the UI in different | |
| 167 languages, which can be configured via the preferences dialog. The Qt and | |
| 168 QScintilla translations are searched in the translations directory given | |
| 169 in the preferences dialog (Qt page). If the translations cannot be found, | |
| 170 some part of the MMI might show English texts even if you have selected | |
| 171 something else. If you are missing eric6 translations for your language | |
| 172 and are willing to volunteer for this work please send me an email naming | |
| 173 the country code and I will send you the respective Qt-Linguist file. | |
| 174 | |
| 175 Window Layout | |
| 176 | |
| 177 eric6 provides different window layouts. In these layouts, the shell window | |
| 178 and the file browser may be embedded or be separat windows. | |
| 179 | |
| 180 Source code documentation | |
| 181 | |
| 182 eric6 has a built in source code documentation generator, which is | |
| 183 usable via the commandline as well. For further details please see | |
| 184 the file README-eric6-doc.txt | |
| 185 | |
| 186 License | |
| 187 | |
| 188 eric6 (and the others) is released under the conditions of the GPL. See | |
| 189 separate license file for more details. Third party software included in | |
| 190 eric6 is released under their respective license and contained in the | |
| 191 eric6 distribution for convenience. | |
| 192 | |
| 193 Bugs and other reports | |
| 194 | |
| 195 Please send bug reports, feature requests or contributions to eric bugs address. | |
| 196 After the IDE is installed you can use the "Report Bug..." entry of the Help menu, | |
| 197 which will send an email to <eric-bugs@eric-ide.python-projects.org. To request | |
| 198 a new feature use the "Request Feature..." entry of the Help menu, which will | |
| 199 send an email to <eric-featurerequest@eric-ide.python-projects.org. |
