Skip to content

Commit

Permalink
DOCS: expand readme (#1)
Browse files Browse the repository at this point in the history
closes #1
  • Loading branch information
dwhieb committed Mar 15, 2019
1 parent 1c97481 commit ff838f3
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Scription

This document specifies a simple text format for representing linguistic texts as interlinear glossed examples. This format, known as `scription` (a term coined by [Patrick J. Hall][Pat Hall] (University of California, Santa Barbara)), makes it easy to quickly enter data. It is easily read by humans, and easily converted to other formats used in documentary linguistics.
# [Scription][GitHub]

[![GitHub release](https://img.shields.io/github/release/digitallinguistics/scription.svg)][releases]
[![DOI](https://zenodo.org/badge/175884660.svg)][Zenodo]
[![GitHub](https://img.shields.io/github/license/digitallinguistics/scription.svg)][license]
[![GitHub stars](https://img.shields.io/github/stars/digitallinguistics/scription.svg?style=social)][GitHub]

This document specifies a simple text format for representing linguistic texts as interlinear glossed examples. This format, known as `scription` (a term coined by [Patrick J. Hall][Pat Hall] (University of California, Santa Barbara)), makes it easy to quickly enter data. It is easily read by humans, and easily converted to other formats used in documentary linguistics.

[View the example scription file.][example]

Expand Down Expand Up @@ -149,7 +152,10 @@ What would this utterance mean if the verb were perfect?

[DaFoDiL]: https://spec.digitallinguistics.io/schemas/Text.html
[example]: https://github.com/digitallinguistics/scription/blob/master/example.txt
[GitHub]: https://github.com/digitallinguistics/scription
[Leipzig]: https://www.eva.mpg.de/lingua/resources/glossing-rules.php
[license]: https://github.com/digitallinguistics/scription/blob/master/LICENSE.md
[Pat Hall]: https://github.com/amundo
[releases]: https://github.com/digitallinguistics/scription/releases
[YAML]: https://yaml.org/start.html
[Zenodo]: https://zenodo.org/badge/latestdoi/175884660

0 comments on commit ff838f3

Please sign in to comment.