Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
giphahne committed Nov 4, 2019
1 parent 8c42e57 commit ef82a14
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,32 @@
# TextGrid Utilities

Installation:
```bash
$ pip install textgrid-utils
```

Add (optional) auto-complete for CLI usage:
```bash
$ eval "$(register-python-argcomplete merge-and-mark-textgrid-tiers)"
```

Command line usage:
```bash
$ merge-and-mark-textgrid-tiers \
-i trial_data.TextGrid \
-o trial_data_merged.TextGrid \
--tiers Phonological Lexical
```


Library usage:

```python
from textgrid_utils import merge_and_mark_tiers

merge_and_mark_tiers(
tg_file="<path/to/input/file>",
output_file="<path/to/output/file>",
tiers=('Phonlogical', 'Lexical'))
```

0 comments on commit ef82a14

Please sign in to comment.