Skip to content

Commit

Permalink
remove README content that was reudndant . Fix readme in a PR
Browse files Browse the repository at this point in the history
  • Loading branch information
MohitYadav-codes committed Apr 12, 2024
1 parent 91c0035 commit 7aa92b8
Showing 1 changed file with 1 addition and 17 deletions.
18 changes: 1 addition & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,2 @@
# Automotive Knowledge Model (AKM)
This repo contains the Automotive Knowledge Model (AKM), an open-source data model and metadata catalog for transmitting vehicle signals in a consistent manner. Please see the overview.md file in the Documentation folder for more information. That folder also contains markdown files for principles and usage guidelines.

The repo has four subfolders:

- **\schema** contains the JSON Schema file(s) that provide the structure and meaning of the automotive metadata files
- **\data** contains the JSON documents that contain the actual Automotive metadata
- **\documentation** contains markdown files that explain aspects of the AKM
- **\rdf** contains a turtle file that expresses the structure and metadata in an ontology

The repo is currently in an alpha release state and should be considered a **DRAFT**. It requires the following work to make it generally available:

- The format and structure of the JSON Schema document requires testing, restructuring, and other quality reviews.
- The tooling that converts VSS to other formats must be available to the AKM. (The AKM tools should be simpler because of the many existing JSON Schema libraries, tooling, etc.)
- The processing of VSS overlays should be supported.
- An assessment of how exposing a DAG that is not necessarily the VSS tree would affect the [VISS](https://www.w3.org/TR/viss2-core/).
- The structure of the data subfolders should be appraised.
- The generation of JSON data documents from RDF and vice versa should be developed.
This repo contains the Automotive Knowledge Model (AKM), an open-source data model and metadata catalog for transmitting vehicle signals in a consistent manner.

0 comments on commit 7aa92b8

Please sign in to comment.