Skip to content

Commit 5875446

Browse files
committed
update install part in doc
1 parent ce18c07 commit 5875446

File tree

2 files changed

+18
-3
lines changed

2 files changed

+18
-3
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,22 @@ data_to_textgrid(data, "copy.TextGrid")
5757

5858
## Install
5959

60+
You can install `gridio` via pip:
61+
6062
```bash
6163
pip install gridio
62-
# or from source
64+
```
65+
66+
Or if you want to build from source, make sure you have Rust and maturin installed, then run:
67+
68+
```bash
6369
maturin develop
6470
```
6571

72+
## Documentation
73+
74+
Comprehensive documentation is available at [https://fncokg.github.io/gridio/](https://fncokg.github.io/gridio/).
75+
6676
## Benchmarks
6777

6878
We benchmark `gridio` against two popular TextGrid parsing libraries: `textgrid` (a pure Python implementation) and `parselmouth` (Python bindings for Praat).

docs/index.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,17 @@ print(first_tier[0], first_tier[2][:2])
5454
data_to_textgrid(data, "copy.TextGrid")
5555
```
5656

57-
5857
## Install
5958

59+
You can install `gridio` via pip:
60+
6061
```bash
6162
pip install gridio
62-
# or from source
63+
```
64+
65+
Or if you want to build from source, make sure you have Rust and maturin installed, then run:
66+
67+
```bash
6368
maturin develop
6469
```
6570

0 commit comments

Comments
 (0)