Mercurial Repositories > eric / file comparison
comparison: docs/README.rst
docs/README.rst
- changeset 7222
- fc6530b432ad
- parent 7037
- 4560e7a43588
- child 7929
- fdd769e06482
equal
deleted
inserted
replaced
| 7221:0485ccdf7877 | 7222:fc6530b432ad |
|---|---|
| 14 <https://eric-ide.python-projects.org>. | 14 <https://eric-ide.python-projects.org>. |
| 15 | 15 |
| 16 1. Installation | 16 1. Installation |
| 17 --------------- | 17 --------------- |
| 18 Installing eric6 is a simple process. There are various methods available. | 18 Installing eric6 is a simple process. There are various methods available. |
| 19 Please choose the one best suited to your needs and skills. eric6 may be used | 19 Please choose the one best suited to your needs and skills. eric6 may be must |
| 20 with any combination of Python 3 or 2, Qt5 or Qt4 and PyQt5 or PyQt4. However, | 20 with Python 3, Qt5 and PyQt5. |
| 21 the recommended combination is **Python3** and **PyQt5**. | |
| 22 | 21 |
| 23 1.1 Create a Python virtual environment for eric6 | 22 1.1 Create a Python virtual environment for eric6 |
| 24 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 23 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 25 It is recommended to install eric6 into a Python virtual environment in order | 24 It is recommended to install eric6 into a Python virtual environment in order |
| 26 to keep your Python distribution clean. In order to do that create it by | 25 to keep your Python distribution clean. In order to do that create it by |
| 213 volunteer for this work please send me an email naming the country code and | 212 volunteer for this work please send me an email naming the country code and |
| 214 I will send you the respective Qt-Linguist file. | 213 I will send you the respective Qt-Linguist file. |
| 215 | 214 |
| 216 12. Window Layout | 215 12. Window Layout |
| 217 ----------------- | 216 ----------------- |
| 218 eric6 provides different window layouts. In these layouts, the shell window | 217 eric6 provides a configurable window layout. The visibility of the various tool |
| 219 and the file browser may be embedded or be separat windows. | 218 panes can be configured. The position of the shell pane may be configured as |
| 219 well. | |
| 220 | 220 |
| 221 13. Source code documentation | 221 13. Source code documentation |
| 222 ----------------------------- | 222 ----------------------------- |
| 223 eric6 has a built in source code documentation generator, which is | 223 eric6 has a built in source code documentation generator, which is |
| 224 usable via the commandline as well. For further details please see | 224 usable via the commandline as well. For further details please see |
| 225 the file README-eric6-doc.rst. | 225 the file README-eric6-doc.rst. |
| 226 | |
| 227 14. Included Tools | |
| 228 ------------------ | |
| 229 eric6 comes with a long list of tools. These can be started via the eric6 | |
| 230 tray starter or directly via the commandline. They are available from within | |
| 231 the IDE. The included tools are (sorted alphabetically): | |
| 232 | |
| 233 * **eric6_api.py** | |
| 234 | |
| 235 This is the tool to generate API files from Python source code. | |
| 236 | |
| 237 * **eric6_browser.py** | |
| 238 | |
| 239 This is the eric6 web browser. It is a full blown browser based on | |
| 240 QtWebEngine, which is based on the Chromium web engine. | |
| 241 | |
| 242 * **eric6_compare.py** | |
| 243 | |
| 244 This tool may be used to compare two files side-by-side. Differences | |
| 245 between the files are highlighted by coloring the text. | |
| 246 | |
| 247 * **eric6_configure.py** | |
| 248 | |
| 249 This is the standalone variant of the configuration dialog. It offers | |
| 250 most of the configuration options as are available from within eric6. | |
| 251 | |
| 252 * **eric6_diff.py** | |
| 253 | |
| 254 This tool may be used to view the differences between two files. These | |
| 255 are shown as a unified or context diff. | |
| 256 | |
| 257 * **eric6_doc.py** | |
| 258 | |
| 259 This is the tool to extract source code documentation from source files | |
| 260 and format that as HTML files. | |
| 261 | |
| 262 * **eric6_editor.py** | |
| 263 | |
| 264 This is a stripped down, standalone variant of the editor embedded in the | |
| 265 eric6 IDE. | |
| 266 | |
| 267 * **eric6_hexeditor.py** | |
| 268 | |
| 269 This is a standalone hex editor to work with binary files. | |
| 270 | |
| 271 * **eric6_iconeditor.py** | |
| 272 | |
| 273 This is a little tool to create pixel based icons and save them in a | |
| 274 pixmap format. | |
| 275 | |
| 276 * **eric6_plugininstall.py** | |
| 277 | |
| 278 This is a standalone utility to install eric6 plug-ins available on the | |
| 279 local machine. | |
| 280 | |
| 281 * **eric6_pluginrepository.py** | |
| 282 | |
| 283 This is a standalone variant of the plug-in repository window. It is used | |
| 284 to view the available plug-ins and download them to the local machine. | |
| 285 | |
| 286 * **eric6_pluginuninstall.py** | |
| 287 | |
| 288 This is a standalone utility to uninstall eric6 plug-ins. | |
| 289 | |
| 290 * **eric6_qregexp.py** | |
| 291 | |
| 292 This tool may be used to create regular expressions based on QRegExp. | |
| 293 | |
| 294 * **eric6_qregularexpression.py** | |
| 295 | |
| 296 This tool may be used to create regular expressions based on | |
| 297 QRegularExpression. | |
| 298 | |
| 299 * **eric6_re.py** | |
| 300 | |
| 301 This tool may be used to create Python regular expressions as used with the | |
| 302 re module. | |
| 303 | |
| 304 * **eric6_shell.py** | |
| 305 | |
| 306 This is a standalone, graphical Python shell application. | |
| 307 | |
| 308 * **eric6_snap.py** | |
| 309 | |
| 310 This tool may be used to create screenshots of the whole screen, individual | |
| 311 windows or selectable areas. | |
| 312 | |
| 313 * **eric6_sqlbrowser.py** | |
| 314 | |
| 315 This is a simple tool to inspect SQL databases. All database products | |
| 316 supported by Qt may be inspected. Note, that Qt database drivers may be | |
| 317 installed first. | |
| 318 | |
| 319 * **eric6_tray.py** | |
| 320 | |
| 321 This is the tray starter application. See above for some details. | |
| 322 | |
| 323 * **eric6_trpreviewer** | |
| 324 | |
| 325 This tool may be used to preview translations of Qt forms. Forms and | |
| 326 language files may be loaded separately. Multiple languages can be loaded | |
| 327 and the active language can be switched between the loaded ones. | |
| 328 | |
| 329 * **eric6_uipreviewer** | |
| 330 | |
| 331 This tool is used to preview Qt forms. The display may be switched between | |
| 332 the available Qt window styles. | |
| 333 | |
| 334 * **eric6_unittest** | |
| 335 | |
| 336 This is a standalone tool to execute existing unit tests. | |
| 226 | 337 |
| 227 14. License | 338 14. License |
| 228 ----------- | 339 ----------- |
| 229 eric6 (and the others) is released under the conditions of the GPLv3. See | 340 eric6 (and the others) is released under the conditions of the GPLv3. See |
| 230 separate license file ``LICENSE.GPL3`` for more details. Third party software | 341 separate license file ``LICENSE.GPL3`` for more details. Third party software |
