Skip to content

Commit

Permalink
Merge pull request #6 from meaningfy-ws/feature/M2O1-22
Browse files Browse the repository at this point in the history
Add paragraph explaining how to use model2owl, update artefacts list
  • Loading branch information
gkostkowski authored Sep 5, 2024
2 parents 0d8abdc + 7dc8962 commit 05e0156
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The following capabilities are implemented:
* UML -> OWL 2 (lightweight ontology suitable as a core vocabulary)
* UML -> OWL 2 (heavyweight ontology with additional axioms suitable for reasoning purposes)
* UML -> SHACL (data shapes suitable for representing an application profile)
* UML -> SVRL (Compliance report in SVRL format)
This documentation is evolving and aims at covering the following aspects related to use of these tools:

Expand All @@ -28,3 +29,6 @@ This documentation is evolving and aims at covering the following aspects relate
* The set of validation rules that check a transformation's conformance to the established conventions (and UML interpretations).
The tools can be used on any other ontology that is built according to the provided https://github.com/OP-TED/model2owl/blob/master/docs/ontology-architecture/ontology-architecture.pdf[modelling architecture] and xref:uml/conceptual-model-conventions.adoc[UML conceptual model conventions].

The toolset can be used in two ways. The first way offers a simplified setup based on https://docs.github.com/en/actions[GitHub Actions] that requires no infrastructure and is available online. It promotes a GIT-based workflow where input, configuration and transformed artefacts are stored in a repository and a user commit triggers execution of the _model2owl_ transformation. Details of that method can be found https://github.com/OP-TED/model2owl?tab=readme-ov-file#online[in the project description].
Alternatively, the software can be installed and executed locally. The user can interact with the software through a https://www.gnu.org/software/make/[Make]-based command line interface. Please check https://github.com/OP-TED/model2owl?tab=readme-ov-file#locally[the installation, configuration and usage instruction] to learn more.

0 comments on commit 05e0156

Please sign in to comment.