hmar-lang commited on
Commit
f2cf9f5
·
1 Parent(s): ca461c1

readme update

Browse files
Files changed (1) hide show
  1. README.md +59 -17
README.md CHANGED
@@ -24,44 +24,86 @@ configs:
24
 
25
  # 📚 Hmar Digital Corpus & Research Archive
26
 
27
- ## 🚧 Status: Solo Preservation Project (Work in Progress)
28
- **This is a personal, manual effort to digitize and catalog Hmar-related materials.** Unlike automated datasets, this corpus is built through **manual scanning of physical volumes** and the careful curation of rare digital documents. Because each book is processed individually—from physical scan to metadata entrythe archive grows one volume at a time.
29
 
30
  **Current Workflow:**
31
- - **Manual Digitization:** Scanning physical books to create high-quality, preserved PDFs.
32
- - **Curation:** Sourcing and verifying existing digital research papers.
33
- - **Standardization:** Creating structured `metadata.json` for every entry to ensure long-term searchability.
34
 
35
  ---
36
 
37
  ## 📋 Project Philosophy
38
- The **Hmar Digital Corpus** aims to prevent the loss of Hmar literature and historical records. By converting physical "Grey Literature" (books with limited circulation, student association journals, and local research) into a structured digital format, we ensure that the Hmar language (ISO 639-3: `hmr`) has a lasting presence in the digital and academic world.
39
 
 
40
 
 
41
 
42
  ## 📂 Repository Structure
43
- The corpus uses an **"Atomic Folder"** system. Every book is a self-contained unit.
44
 
45
  ```text
46
  books/
47
- ├── hmar/ # Hmar language literature & textbooks (Manual Scans)
48
- ├── mizo/ # Mizo-language works regarding Hmar history
49
  ├── english/ # Academic research, ethnographies, and linguistics
50
  └── bilingual/ # Dictionaries, primers, and parallel texts
51
  ```
52
 
 
 
 
 
 
 
 
53
  ## 🔍 Metadata & Searchability
54
- Each folder contains a `metadata.json` file. This is crucial for solo project management, as it allows the archive to remain organized regardless of how many files are added.
 
 
 
55
 
56
- - **Core Fields:** Title (Bilingual), Author, Year, Publisher.
57
- - **Extra Metadata:** Includes specific context like Government approval letters, author credentials, or physical source notes.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
58
 
59
  ## 🛠 Progress & Limitations
60
- As a solo maintainer manually scanning these works:
61
- 1. **OCR is a secondary phase:** The priority is first securing the PDF and Metadata.
62
- 2. **Updates are periodic:** New volumes are pushed to the repository as they are completed.
 
 
63
 
64
  ## ⚖️ Rights & Usage
65
- This archive is curated for **non-commercial research, linguistic study, and cultural preservation**.
66
 
67
- Copyright remains with the original authors, societies, and publishers (e.g., HLS, HSA, AIRTSC). If you are a rights holder and wish to have a document removed or updated, please contact the maintainer via the repository's discussion tab.
 
24
 
25
  # 📚 Hmar Digital Corpus & Research Archive
26
 
27
+ ## 🚧 Status: Work in Progress
28
+ This archive documents and preserves Hmar-related literature through **manual digitization of physical volumes** and the curation of rare digital materials. Each work is processed individually—from scan to metadata—to prioritize long-term preservation and research usability over scale.
29
 
30
  **Current Workflow:**
31
+ - **Digitization:** High-quality scans of physical books and documents.
32
+ - **Curation:** Collection and verification of existing digital research papers.
33
+ - **Standardization:** Structured metadata (`metadata.json`) for every entry to ensure consistent indexing and retrieval.
34
 
35
  ---
36
 
37
  ## 📋 Project Philosophy
38
+ The **Hmar Digital Corpus** exists to prevent the loss of Hmar literature and historical records. By converting limited-circulation books, community publications, and local research into a structured digital archive, the project ensures that the Hmar language (ISO 639-3: `hmr`) remains accessible for academic, linguistic, and cultural research.
39
 
40
+ This project prioritizes **preservation, provenance, and transparency** over textual polish or scale.
41
 
42
+ ---
43
 
44
  ## 📂 Repository Structure
45
+ The corpus follows an **Atomic Folder** model: each book or document is a self-contained unit.
46
 
47
  ```text
48
  books/
49
+ ├── hmar/ # Hmar language literature & textbooks
50
+ ├── mizo/ # Mizo-language works concerning Hmar history
51
  ├── english/ # Academic research, ethnographies, and linguistics
52
  └── bilingual/ # Dictionaries, primers, and parallel texts
53
  ```
54
 
55
+ Each document folder typically contains:
56
+ - the scanned PDF (authoritative artifact),
57
+ - a `metadata.json` file,
58
+ - and, when available, an `ocr/` directory.
59
+
60
+ ---
61
+
62
  ## 🔍 Metadata & Searchability
63
+ Every document directory includes a `metadata.json` file, enabling reliable organization and search at scale.
64
+
65
+ - **Core Fields:** Title (bilingual where applicable), Author, Year, Publisher.
66
+ - **Extended Metadata:** Contextual information such as institutional approvals, author credentials, edition notes, or physical source details.
67
 
68
+ Metadata is treated as first-class data and is required even when OCR is absent.
69
+
70
+ ---
71
+
72
+ ## 📁 OCR Directory Structure
73
+ When available, OCR output is stored in a dedicated `ocr/` subdirectory within each book or document folder.
74
+
75
+ **Example structure:**
76
+ ```text
77
+ Bilingual/
78
+ └── hmar_tawng_inchukna/
79
+ ├── hmar_tawng_inchukna_2012.pdf
80
+ ├── metadata.json
81
+ └── ocr/
82
+ └── hmar_tawng_inchukna_2012.txt
83
+ ```
84
+
85
+ ### OCR File Semantics
86
+ - The `ocr/` directory contains **raw, untouched OCR output**.
87
+ - In the current corpus, OCR is typically stored as a **single consolidated `.txt` file** corresponding to the scanned PDF.
88
+ - In future entries, OCR may also be organized per page or per chapter where useful.
89
+ - No semantic corrections, spell-checking, normalization, or stylistic cleanup is applied unless explicitly documented in metadata.
90
+
91
+ The presence of an `ocr/` directory **does not imply textual accuracy or verification**. OCR text exists to support search, reference, and future annotation—not as a definitive transcription.
92
+
93
+ The scanned PDF remains the **authoritative source** unless a text has been explicitly marked as *verified* or *curated* in its metadata.
94
+
95
+ Any corrected or curated text—if introduced—will exist as a **separate layer** and will retain explicit references to the original OCR output.
96
+
97
+ ---
98
 
99
  ## 🛠 Progress & Limitations
100
+ 1. **Preservation first:** Priority is given to securing high-quality scans and accurate metadata.
101
+ 2. **OCR is secondary:** OCR is generated opportunistically and may be incomplete or error-prone.
102
+ 3. **Incremental growth:** Materials are added as they are processed and documented.
103
+
104
+ ---
105
 
106
  ## ⚖️ Rights & Usage
107
+ This archive is provided for **non-commercial research, linguistic study, and cultural preservation**.
108
 
109
+ Copyright remains with the original authors, societies, and publishers (e.g., HLS, HSA, AIRTSC). Rights holders may request removal or modification of materials through the repositorys discussion channel.