Skip to content

Commit 66aafa3

Browse files
committed
Added DOI to README
1 parent 0d537c8 commit 66aafa3

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,30 @@
88
![lint](https://github.com/mbsantiago/whombat/actions/workflows/lint.yml/badge.svg)
99
![docs](https://github.com/mbsantiago/whombat/actions/workflows/docs.yml/badge.svg)
1010
![tests](https://github.com/mbsantiago/whombat/actions/workflows/test.yml/badge.svg)
11+
[![DOI](https://zenodo.org/badge/682458553.svg)](https://zenodo.org/doi/10.5281/zenodo.10604169)
1112

1213
**Whombat** is an open-source, web-based audio annotation tool designed to streamline audio data labeling and annotation, with a particular focus on supporting machine learning model development.
1314

1415
## Installation
1516

1617
Visit the [Releases](https://github.com/mbsantiago/whombat/releases) section on GitHub to download the bundled version compatible with your operating system.
1718

19+
If you prefer installing Whombat via Python, run the command
20+
21+
```bash
22+
pip install whombat
23+
```
24+
1825
For detailed installation instructions, refer to the [Installation](https://mbsantiago.github.io/whombat/user_guide/installation/) section of the documentation.
1926

2027
## Usage
2128

29+
To run whombat either click on the bundled executable or run
30+
31+
```bash
32+
python -m whombat
33+
```
34+
2235
We have prepared a [User Guide](https://mbsantiago.github.io/whombat/user_guide/) to accompany you in your annotation work.
2336
There you will be able to see all the features provided by Whombat, as well as clear instructions on how to use them.
2437

0 commit comments

Comments
 (0)