Skip to content

Commit 5d1fecc

Browse files
committed
Update readme
1 parent 8fe090b commit 5d1fecc

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
PyDev Predefined Completions Generator for GIMP
22
===============================================
33

4-
This simple Python script generates [predefined completions](http://www.pydev.org/manual_101_interpreter.html) for [PyDev](http://www.pydev.org/)
5-
for GIMP and GTK modules to improve development of GIMP plug-ins written in Python.
4+
This simple Python script generates
5+
[predefined completions](http://www.pydev.org/manual_101_interpreter.html)
6+
for [PyDev](http://www.pydev.org/) for GIMP and GTK modules to improve
7+
development of GIMP plug-ins written in Python.
68

79
Development of GIMP plug-ins in Python is provided by several Python modules
810
compiled as `.pyd` files. However, PyDev has trouble parsing such files,
@@ -15,19 +17,32 @@ completions for GIMP and GTK Python modules. Additionally, this script also
1517
generates predefined completions for all plug-ins and procedures installed in
1618
GIMP.
1719

20+
Requirements
21+
------------
22+
23+
* This script is written as a GIMP plug-in and therefore requires GIMP, version
24+
2.8 or later.
25+
* [astor](https://github.com/berkerpeksag/astor) library
26+
27+
28+
Installation
29+
------------
30+
31+
1. Install the script by copying all files to the
32+
`[user directory]/.gimp-<version>/plug-ins` directory.
33+
2. Download the [astor](https://github.com/berkerpeksag/astor) library and
34+
install it in `[user directory]/.gimp-<version>/plug-ins` directory.
35+
1836

1937
Running the Generator
2038
---------------------
2139

22-
The script is written as a GIMP plug-in. To run the generator:
40+
To run the generator, open GIMP and choose
41+
`Filters -> Python-Fu -> Generate Predefined Completions for PyDev`.
2342

24-
1. Install the plug-in by copying all files to the
25-
`[user directory]/.gimp-<version>/plug-ins` directory.
26-
2. Open GIMP and choose
27-
`Filters -> Python-Fu -> Generate Predefined Completions for PyDev`.
28-
Alternatively, you may run the plug-in from the Python-Fu console: open GIMP,
29-
choose `Filters -> Python-Fu -> Console` and enter
30-
`pdb.generate_predefined_completions_for_pydev()`.
43+
Alternatively, you may run the plug-in from the Python-Fu console: Open GIMP,
44+
choose `Filters -> Python-Fu -> Console` and enter
45+
pdb.generate_predefined_completions_for_pydev()`.
3146

3247

3348
Installing Predefined Completions in PyDev

0 commit comments

Comments
 (0)