Skip to content

Commit 12ad6ac

Browse files
committed
fix: readme md
1 parent e52763d commit 12ad6ac

1 file changed

Lines changed: 14 additions & 13 deletions

File tree

README renamed to README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ The ontology is designed to provide a shared conceptual framework and common voc
66
## 📚 Purpose of the Ontology
77
An ontology defines terms, relationships, and structures to describe a particular domain — in this case, regenerative materials. For AREMA, this ontology serves multiple purposes:
88

9-
Controlled Vocabulary for the Website
9+
### Controlled Vocabulary for the Website
1010
It powers the AREMA front-end by providing a standardized vocabulary for categories, material properties, processes, and more. This ensures that users interact with consistent terms throughout the platform.
1111

12-
Interoperability and Data Quality
13-
By formalizing the domain knowledge as RDF and SHACL, the ontology supports structured data exchange and integration with external systems, while enabling automated quality checks and re-using existig metadata standards.
12+
### Interoperability and Data Quality
13+
By formalizing the domain knowledge as RDF and SHACL, the ontology supports structured data exchange and integration with external systems, while enabling automated quality checks and re-using existing metadata standards.
1414

15-
Documentation and Transparency
15+
### Documentation and Transparency
1616
It provides a clear, explicit model of how AREMA organizes knowledge about regenerative materials.
1717

1818
## 📂 Repository Structure
@@ -37,24 +37,25 @@ AREMA Ontology Repository
3737
│ └── sparql.py
3838
└── requirements.txt
3939
```
40-
Key Components
41-
src/ontology/:
40+
41+
### Key Components
42+
**src/ontology/**:
4243
The core ontology in Turtle (.ttl) format.
4344

44-
src/quality-checks/:
45+
**src/quality-checks/**:
4546
SHACL shapes for validating ontology consistency and compatibility with tools like SKOHUB.
4647

47-
tools/python/:
48+
**tools/python/**:
4849
Python scripts for running SHACL checks.
4950

5051
## 🔍 Quality Assurance
51-
We employ SHACL shapes to validate the ontology structure and ensure ongoing data integrity. Scripts in tools/python/ assist with:
52-
53-
Running SHACL validation against the ontology.
52+
We employ SHACL shapes to validate the ontology structure and ensure ongoing data integrity. Scripts in `tools/python/` assist with:
5453

55-
Generating documentation from SPARQL queries.
54+
- Running SHACL validation against the ontology.
55+
- Generating documentation from SPARQL queries.
5656

5757
## 🚀 Usage (For Developers / Maintainers)
58+
5859
### Requirements
5960
```bash
6061
pip install -r tools/python/requirements.txt
@@ -63,4 +64,4 @@ pip install -r tools/python/requirements.txt
6364
### Run SHACL Checks
6465
```bash
6566
python tools/python/checks/shacl.py
66-
```
67+
```

0 commit comments

Comments
 (0)