Skip to content

Commit 74744ee

Browse files
authored
Update README.md
1 parent 04e2472 commit 74744ee

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,17 @@
22

33
A specification for the **Minimum Information about any (X) Sequence** standard
44

5-
## Purpose and Contents
5+
## Repository Contents
66

77
This repo contains computable artifacts that define the MIxS standard, versions 6 and later. _Older versions of the MIxS standard are available at https://github.com/GenomicsStandardsConsortium/mixs-legacy_
88

99
Beginning with version 6, MIxS is being managed using the [LinkML toolkit](https://linkml.io/). LinkML uses YAML files to describe schemas and provides code to convert YAML to multiple other formats.
1010

11-
The latests stable version of the MIxS standard in various formats listed above are available in the [release](release) folder. MIxS is currently available in GraphQL, JSON-LD, JSON schema, OWL, prefixmap, protobuf, SCHACL, SHEX, SQL schema and Python. Java will be addde in a future release, as will Excel templates for data collection.
12-
13-
There is currently only one version of MIxS released in this repository (MIxS 6). When newer versions are released, links to older versions will be provided here.
14-
1511
### How to access MIxS standards
1612

17-
The standards can be browsed at https://genomicsstandardsconsortium.github.io/mixs/ or downloaded in machine readable formats from the [release](release) folder.
13+
The standards can be browsed at https://genomicsstandardsconsortium.github.io/mixs/. The latests stable version of the MIxS standard in various formatsdownloaded in machine readable formats from the [release](release) folder. MIxS is currently available in GraphQL, JSON-LD, JSON schema, OWL, prefixmap, protobuf, SCHACL, SHEX, SQL schema and Python. Java will be addde in a future release, as will Excel templates for data collection. There is currently only one version of MIxS released in this repository (MIxS 6). When newer versions are released, links to older versions will be provided here
1814

19-
To support existing implementers who have been using previous Excel-based versions of MIxS, we have provide a manually created [Excel workbook] (release/mixs6/xlsx) with the same format as MIxS 5. However, we highly recommend using one of the machine readable artifacts available in the [release](release) folder.
15+
To support existing implementers who have been using previous Excel-based versions of MIxS, we have provide a manually created [Excel workbook](release/excel) with the same format as MIxS 5. However, we highly recommend using one of the machine readable artifacts available in the [release](release) folder.
2016

2117
MIxS is divided into checklists and packages.
2218

@@ -29,6 +25,12 @@ Packages can be used in conjunction with any checklist, so, for example, you if
2925

3026
**To request changes to the MIxS standards, please use the [issue tracker](https://github.com/GenomicsStandardsConsortium/mixs/issues) in this repo.**
3127

28+
### Other repository contents
29+
30+
- [generated](generated) contains a working version of the MIxS artifacts. It is not stable and should not be used!
31+
- [doc_templates](doc_templates) contains jinja templates for the LinkML auto-generated documentation
32+
- [changelogs](changelogs) contains documents describing the changes with each release
33+
- [MAINTAINERS.md](MAINTAINERS.md) provides more technical details on the editing and release process
3234

3335
## Guidelines for the reuse and citation of content on this repository
3436

0 commit comments

Comments
 (0)