tmdinosaurcenter
/
dwc
mirror of https://github.com/tdwg/dwc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add intended repository structure

This commit is contained in:
Peter Desmet 2017-09-29 23:49:10 -04:00 committed by GitHub
parent 0fed4f5af6
commit ada5c6006c
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -8,6 +8,34 @@ This repository is dedicated to the maintenance of the Darwin Core standard. For
The Darwin Core is body of standards. It includes a glossary of terms (in other contexts these might be called properties, elements, fields, columns, attributes, or concepts) intended to facilitate the sharing of information about biological diversity by providing reference definitions, examples, and commentaries. The Darwin Core is primarily based on taxa, their occurrence in nature as documented by observations, specimens, samples, and related information. Included are documents describing how these terms are managed, how the set of terms can be extended for new purposes, and how the terms can be used.
## Repo structure
The repository structure is described below. Files/directories indicated with `GENERATED` should not be edited manually.
```
├── README.md : Description of this repository
├── LICENSE : Repository license
│
├── vocabulary
│ └── term_versions.csv : The normative document of Darwin Core, where the standard is maintained
│
├── src
│   ├── build.py           : Build script to generate distribution files from the normative document
│ └── config : Configuration files for build.py
│   ├── index.tmpl       : Template for index.html
│ └── terms_config.csv : Configuration for the recommended terms, incl. order, labels, examples
│
├── dist : GENERATED Distribution files generated by build.py
│ ├── recommended_terms.csv : GENERATED CSV file with the recommended Darwin Core terms
│ └── index.html : GENERATED Web page with the recommended Darwin Core terms
│
├── .github
│ ├── CONTRIBUTING.md : Guide on how to contribute to Darwin Core
│ └── ISSUE_TEMPLATE.md : Template for issues
│
└── .gitignore : Files and directories to be ignored by git
```
## License
Darwin Core (c) by the Darwin Core Task Group, Biodiversity Informatics Standards (TDWG). Darwin Core is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/). A copy of the license is provided in [LICENSE](LICENSE).