Skip to content
This repository was archived by the owner on Aug 18, 2018. It is now read-only.

Commit 7f161bd

Browse files
pettarinpettarin
committed
Fixed typo in README
1 parent 4897df8 commit 7f161bd

3 files changed

Lines changed: 46 additions & 44 deletions

File tree

‎README.md‎

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -84,21 +84,23 @@ This procedure will not any dependencies, see below.
8484
### Dependencies
8585

8686
* Python, version 2.7.x or 3.4.x (or above)
87-
* to write StarDict dictionaries: the `dictzip` executable, available in your `$PATH` or specified with `--dictzip-path`
87+
88+
* to write StarDict dictionaries: the `dictzip` executable, available in your `$PATH` or specified with `--dictzip-path`:
8889

8990
```bash
9091
$ [sudo] apt-get install dictzip
9192
```
9293

93-
* to read/write Kobo dictionaries: the Python module `marisa-trie`
94+
* to read/write Kobo dictionaries: the Python module `marisa-trie`:
9495

9596
```bash
9697
$ [sudo] pip install marisa-trie
9798
```
9899

99100
or [`MARISA`](https://code.google.com/p/marisa-trie/) executables available in your `$PATH` or specified with `--marisa-bin-path`
100101
* to write MOBI Kindle dictionaries: the [`kindlegen`](https://www.amazon.com/gp/feature.html?docId=1000765211) executable, available in your `$PATH` or specified with `--kindlegen-path`
101-
* to read/write XML dictionaries: the Python module `lxml`
102+
103+
* to read/write XML dictionaries: the Python module `lxml`:
102104

103105
```bash
104106
$ [sudo] pip install lxml
@@ -109,9 +111,9 @@ This procedure will not any dependencies, see below.
109111

110112
```
111113
usage:
112-
$ penelope.py -h
113-
$ penelope.py -i INPUT_FILE -j INPUT_FORMAT -f LANGUAGE_FROM -t LANGUAGE_TO -p OUTPUT_FORMAT -o OUTPUT_FILE [OPTIONS]
114-
$ penelope.py -i IN1,IN2[,IN3...] -j INPUT_FORMAT -f LANGUAGE_FROM -t LANGUAGE_TO -p OUTPUT_FORMAT -o OUTPUT_FILE [OPTIONS]
114+
$ penelope -h
115+
$ penelope -i INPUT_FILE -j INPUT_FORMAT -f LANGUAGE_FROM -t LANGUAGE_TO -p OUTPUT_FORMAT -o OUTPUT_FILE [OPTIONS]
116+
$ penelope -i IN1,IN2[,IN3...] -j INPUT_FORMAT -f LANGUAGE_FROM -t LANGUAGE_TO -p OUTPUT_FORMAT -o OUTPUT_FILE [OPTIONS]
115117

116118
description:
117119
Convert dictionary file(s) with file name prefix INPUT_FILE from format INPUT_FORMAT to format OUTPUT_FORMAT, saving it as OUTPUT_FILE.
@@ -212,43 +214,43 @@ optional arguments:
212214

213215
examples:
214216

215-
$ penelope.py -i dict.csv -j csv -f en -t it -p stardict -o output.zip
217+
$ penelope -i dict.csv -j csv -f en -t it -p stardict -o output.zip
216218
Convert en->it dictionary dict.csv (in CSV format) into output.zip (in StarDict format)
217219

218-
$ penelope.py -i dict.csv -j csv -f en -t it -p stardict -o output.zip --merge-definitions
220+
$ penelope -i dict.csv -j csv -f en -t it -p stardict -o output.zip --merge-definitions
219221
As above, but also merge definitions
220222

221-
$ penelope.py -i d1,d2,d3 -j csv -f en -t it -p csv -o output.csv --sort-after --sort-by-headword
223+
$ penelope -i d1,d2,d3 -j csv -f en -t it -p csv -o output.csv --sort-after --sort-by-headword
222224
Merge CSV dictionaries d1, d2, and d3 into output.csv, sorting by headword
223225

224-
$ penelope.py -i d1,d2,d3 -j csv -f en -t it -p csv -o output.csv --sort-after --sort-by-headword --sort-ignore-case
226+
$ penelope -i d1,d2,d3 -j csv -f en -t it -p csv -o output.csv --sort-after --sort-by-headword --sort-ignore-case
225227
As above, but ignore case for sorting
226228

227-
$ penelope.py -i d1,d2,d3 -j csv -f en -t it -p csv -o output.csv --sort-after --sort-by-headword --sort-reverse
229+
$ penelope -i d1,d2,d3 -j csv -f en -t it -p csv -o output.csv --sort-after --sort-by-headword --sort-reverse
228230
As above, but reverse the order
229231

230-
$ penelope.py -i dict.zip -j stardict -f en -t it -p csv -o output.csv
232+
$ penelope -i dict.zip -j stardict -f en -t it -p csv -o output.csv
231233
Convert en->it dictionary dict.zip (in StarDict format) into output.csv (in CSV format)
232234

233-
$ penelope.py -i dict.zip -j stardict -f en -t it -p csv -o output.csv --ignore-synonyms
235+
$ penelope -i dict.zip -j stardict -f en -t it -p csv -o output.csv --ignore-synonyms
234236
As above, but do not read the .syn synonym file if present
235237

236-
$ penelope.py -i dict.zip -j stardict -f en -t it -p csv -o output.csv --flatten-synonyms
238+
$ penelope -i dict.zip -j stardict -f en -t it -p csv -o output.csv --flatten-synonyms
237239
As above, but flatten synonyms
238240

239-
$ penelope.py -i dict.zip -j stardict -f en -t it -p bookeen -o output
241+
$ penelope -i dict.zip -j stardict -f en -t it -p bookeen -o output
240242
Convert dict.zip into output.dict.idx and output.dict for Bookeen devices
241243

242-
$ penelope.py -i dict.zip -j stardict -f en -t it -p kobo -o dicthtml-en-it
244+
$ penelope -i dict.zip -j stardict -f en -t it -p kobo -o dicthtml-en-it
243245
Convert dict.zip into dicthtml-en-it.zip for Kobo devices
244246

245-
$ penelope.py -i dict.csv -j csv -f en -t it -p mobi -o output.mobi --cover-path mycover.png --title "My English->Italian Dictionary"
247+
$ penelope -i dict.csv -j csv -f en -t it -p mobi -o output.mobi --cover-path mycover.png --title "My English->Italian Dictionary"
246248
Convert dict.csv into a MOBI (Kindle) dictionary, using the specified cover image and title
247249

248-
$ penelope.py -i dict.xml -j xml -f en -t it -p mobi -o output.epub
250+
$ penelope -i dict.xml -j xml -f en -t it -p mobi -o output.epub
249251
Convert dict.xml into an EPUB dictionary
250252

251-
$ penelope.py -i dict.xml -j xml -f en -t it -p mobi -o output.epub --epub-output-definitions
253+
$ penelope -i dict.xml -j xml -f en -t it -p mobi -o output.epub --epub-output-definitions
252254
As above, but also output definitions
253255

254256
```

‎README.rst‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,15 @@ Dependencies
102102
~~~~~~~~~~~~
103103

104104
- Python, version 2.7.x or 3.4.x (or above)
105+
105106
- to write StarDict dictionaries: the ``dictzip`` executable, available
106-
in your ``$PATH`` or specified with ``--dictzip-path``
107+
in your ``$PATH`` or specified with ``--dictzip-path``:
107108

108109
.. code:: bash
109110
110111
$ [sudo] apt-get install dictzip
111112
112-
- to read/write Kobo dictionaries: the Python module ``marisa-trie``
113+
- to read/write Kobo dictionaries: the Python module ``marisa-trie``:
113114

114115
.. code:: bash
115116
@@ -120,24 +121,23 @@ available in your ``$PATH`` or specified with ``--marisa-bin-path`` \*
120121
to write MOBI Kindle dictionaries: the
121122
```kindlegen`` <https://www.amazon.com/gp/feature.html?docId=1000765211>`__
122123
executable, available in your ``$PATH`` or specified with
123-
``--kindlegen-path`` \* to read/write XML dictionaries: the Python
124-
module ``lxml``
124+
``--kindlegen-path``
125125

126-
::
126+
- to read/write XML dictionaries: the Python module ``lxml``:
127+
128+
.. code:: bash
127129
128-
```bash
129-
$ [sudo] pip install lxml
130-
```
130+
$ [sudo] pip install lxml
131131
132132
Usage
133133
-----
134134

135135
::
136136

137137
usage:
138-
$ penelope.py -h
139-
$ penelope.py -i INPUT_FILE -j INPUT_FORMAT -f LANGUAGE_FROM -t LANGUAGE_TO -p OUTPUT_FORMAT -o OUTPUT_FILE [OPTIONS]
140-
$ penelope.py -i IN1,IN2[,IN3...] -j INPUT_FORMAT -f LANGUAGE_FROM -t LANGUAGE_TO -p OUTPUT_FORMAT -o OUTPUT_FILE [OPTIONS]
138+
$ penelope -h
139+
$ penelope -i INPUT_FILE -j INPUT_FORMAT -f LANGUAGE_FROM -t LANGUAGE_TO -p OUTPUT_FORMAT -o OUTPUT_FILE [OPTIONS]
140+
$ penelope -i IN1,IN2[,IN3...] -j INPUT_FORMAT -f LANGUAGE_FROM -t LANGUAGE_TO -p OUTPUT_FORMAT -o OUTPUT_FILE [OPTIONS]
141141

142142
description:
143143
Convert dictionary file(s) with file name prefix INPUT_FILE from format INPUT_FORMAT to format OUTPUT_FORMAT, saving it as OUTPUT_FILE.
@@ -238,43 +238,43 @@ Usage
238238

239239
examples:
240240

241-
$ penelope.py -i dict.csv -j csv -f en -t it -p stardict -o output.zip
241+
$ penelope -i dict.csv -j csv -f en -t it -p stardict -o output.zip
242242
Convert en->it dictionary dict.csv (in CSV format) into output.zip (in StarDict format)
243243

244-
$ penelope.py -i dict.csv -j csv -f en -t it -p stardict -o output.zip --merge-definitions
244+
$ penelope -i dict.csv -j csv -f en -t it -p stardict -o output.zip --merge-definitions
245245
As above, but also merge definitions
246246

247-
$ penelope.py -i d1,d2,d3 -j csv -f en -t it -p csv -o output.csv --sort-after --sort-by-headword
247+
$ penelope -i d1,d2,d3 -j csv -f en -t it -p csv -o output.csv --sort-after --sort-by-headword
248248
Merge CSV dictionaries d1, d2, and d3 into output.csv, sorting by headword
249249

250-
$ penelope.py -i d1,d2,d3 -j csv -f en -t it -p csv -o output.csv --sort-after --sort-by-headword --sort-ignore-case
250+
$ penelope -i d1,d2,d3 -j csv -f en -t it -p csv -o output.csv --sort-after --sort-by-headword --sort-ignore-case
251251
As above, but ignore case for sorting
252252

253-
$ penelope.py -i d1,d2,d3 -j csv -f en -t it -p csv -o output.csv --sort-after --sort-by-headword --sort-reverse
253+
$ penelope -i d1,d2,d3 -j csv -f en -t it -p csv -o output.csv --sort-after --sort-by-headword --sort-reverse
254254
As above, but reverse the order
255255

256-
$ penelope.py -i dict.zip -j stardict -f en -t it -p csv -o output.csv
256+
$ penelope -i dict.zip -j stardict -f en -t it -p csv -o output.csv
257257
Convert en->it dictionary dict.zip (in StarDict format) into output.csv (in CSV format)
258258

259-
$ penelope.py -i dict.zip -j stardict -f en -t it -p csv -o output.csv --ignore-synonyms
259+
$ penelope -i dict.zip -j stardict -f en -t it -p csv -o output.csv --ignore-synonyms
260260
As above, but do not read the .syn synonym file if present
261261

262-
$ penelope.py -i dict.zip -j stardict -f en -t it -p csv -o output.csv --flatten-synonyms
262+
$ penelope -i dict.zip -j stardict -f en -t it -p csv -o output.csv --flatten-synonyms
263263
As above, but flatten synonyms
264264

265-
$ penelope.py -i dict.zip -j stardict -f en -t it -p bookeen -o output
265+
$ penelope -i dict.zip -j stardict -f en -t it -p bookeen -o output
266266
Convert dict.zip into output.dict.idx and output.dict for Bookeen devices
267267

268-
$ penelope.py -i dict.zip -j stardict -f en -t it -p kobo -o dicthtml-en-it
268+
$ penelope -i dict.zip -j stardict -f en -t it -p kobo -o dicthtml-en-it
269269
Convert dict.zip into dicthtml-en-it.zip for Kobo devices
270270

271-
$ penelope.py -i dict.csv -j csv -f en -t it -p mobi -o output.mobi --cover-path mycover.png --title "My English->Italian Dictionary"
271+
$ penelope -i dict.csv -j csv -f en -t it -p mobi -o output.mobi --cover-path mycover.png --title "My English->Italian Dictionary"
272272
Convert dict.csv into a MOBI (Kindle) dictionary, using the specified cover image and title
273273

274-
$ penelope.py -i dict.xml -j xml -f en -t it -p mobi -o output.epub
274+
$ penelope -i dict.xml -j xml -f en -t it -p mobi -o output.epub
275275
Convert dict.xml into an EPUB dictionary
276276

277-
$ penelope.py -i dict.xml -j xml -f en -t it -p mobi -o output.epub --epub-output-definitions
277+
$ penelope -i dict.xml -j xml -f en -t it -p mobi -o output.epub --epub-output-definitions
278278
As above, but also output definitions
279279
280280

‎setup.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
name="penelope",
1919
packages=["penelope"],
2020
package_data={"penelope": ["res/*"]},
21-
version="3.0.1.9",
21+
version="3.0.1.10",
2222
description="Penelope is a multi-tool for creating, editing and converting dictionaries, especially for eReader devices",
2323
author="Alberto Pettarin",
2424
author_email="alberto@albertopettarin.it",

0 commit comments

Comments
 (0)