Skip to content

Commit 6a5db28

Browse files
committed
Update README to reflect updates to the Python ...
... script and the addition of the Docker container
1 parent efba05a commit 6a5db28

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Updated: January 27, 2017
5757

5858
[1]: http://bibletechnologies.net/
5959

60-
## Javascript npm module
60+
## Perl script for JSON output
6161

6262
There is a perl script which generates a JSON version of the morphology which is published to npm here:
6363
https://www.npmjs.com/package/morphhb
@@ -79,14 +79,19 @@ The perl script which generates this is called morphhbXML-to-JSON.pl. It has sev
7979
- remapVerses: The versification in Hebrew and English bibles is different. This option maps the Hebrew verses to the English ones.
8080

8181
You can run this script like so:
82-
`perl morphhbXML-to-JSON.pl --stripPointing --removeLemmaTypes --prefixLemmasWithH --remapVerses`
8382

84-
## Updated
83+
`perl morphhbXML-to-JSON.pl --stripPointing --removeLemmaTypes --prefixLemmasWithH --remapVerses`
8584

86-
The Python script has been updated to reflect contemporary data practices and to promote cross-platform cooperation.
85+
86+
## Python script with Docker
87+
88+
There is also a Python script to transform the data into a JSON file.
89+
90+
It has similar arguments as the perl script above, but it has the argument `--splitByBook`.
8791

8892
Use `--splitByBook` to create a JSON file per book.
8993

90-
This is usable directly or via Docker:
94+
The python script can be run in a Docker container based on the `Dockerfile` in the main directory. To build the docker image
95+
and run the container, use the following commands (possibly as root):
9196

9297
docker build . -t local/morphhb && docker run -it -v `pwd`:/var/app local/morphhb

0 commit comments

Comments
 (0)