Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gschare authored Oct 29, 2020
1 parent 1a2adc8 commit 94d158d
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# manuscript-object

The `BnF` class represents a python version of BnF Ms 640. It contains a list of `Recipe` objects, which hold the raw XML data from each entry along with some other data such as length and properties.
The `Manuscript` class represents a python version of BnF Ms 640. It contains a list of `Entry` objects, which hold the raw XML data from each entry along with some other data such as categories, title, ID, and properties.

When `BnF` is instantiated, it loads every folio in [`ms-xml`](https://github.com/cu-mkp/m-k-manuscript-data/tree/master/ms-xml) and processes it into its component entries, each of which becomes a `Recipe` object.
When `Manuscript` is instantiated, it loads every folio in [`ms-xml`](https://github.com/cu-mkp/m-k-manuscript-data/tree/master/ms-xml) and processes it into its component entries, each of which becomes a `Entry` object.

`update.py` is a script that generates the `BnF` object and then writes derivative forms and the entry-metadata table to the [m-k-manuscript-data repository](https://github.com/cu-mkp/m-k-manuscript-data).
`update.py` is a script that generates the `Manuscript` object and then writes derivative forms and the entry-metadata table to the [m-k-manuscript-data repository](https://github.com/cu-mkp/m-k-manuscript-data).

The derivative files/folders are:
- allFolios/: for each version, a single XML file containing each folio concatenated together
Expand Down

0 comments on commit 94d158d

Please sign in to comment.