Skip to content

Commit 263463f

Browse files
authored
Update README.md
1 parent 4c823cd commit 263463f

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ You also need to setup a MySQL Server by downloading the [installer](https://dev
1313

1414
If you have issues you can follow this [official tutorial](https://dev.mysql.com/doc/mysql-getting-started/en).
1515

16+
Your data must follow the format presented in the `dummy_data` folder.
17+
1618
Then clone the repository and navigate to it via the terminal. Install the necessary Python libraries :
1719
```
1820
pip install -r requirements.txt
@@ -63,3 +65,17 @@ The last step is to use the third script to produce authority lists. This script
6365
--db databasename \
6466
--out ./output_folder
6567
```
68+
## Final Notice
69+
70+
This codebase is provided as a flexible and extensible framework.
71+
Although it has been developed for a specific research context, its structure and logic are intentionally modular and can be adapted to other datasets, schemas, or workflows.
72+
73+
Users are encouraged to modify, extend, or repurpose the code to fit their own use cases, including but not limited to:
74+
75+
Different database structures
76+
77+
Alternative authority lists or controlled vocabularies
78+
79+
Other TEI / EpiDoc–based projects or XML standards
80+
81+
No part of the code is considered fixed or prescriptive. Adjustments may be required depending on local requirements, data models, or institutional practices.

0 commit comments

Comments
 (0)