Skip to content

Commit

Permalink
Tweak README and bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
Robert M Ochshorn authored and Robert M Ochshorn committed May 26, 2016
1 parent f3f351f commit 5c8340c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
# Gentle
**Robust yet lenient forced-aligner built on Kaldi. A tool for aligning speech with text.**

![Beta](https://img.shields.io/badge/status-beta-red.svg)
[![Build Status](https://img.shields.io/travis/lowerquality/gentle.svg)](https://travis-ci.org/lowerquality/gentle)

## Getting Started

There are three ways to install Gentle.

1. Download the [pre-built Mac application](https://github.com/lowerquality/gentle/releases/download/0.7.0/gentle-0.7.0.dmg). This package includes a GUI that will start the server and a browser. It only works on Mac OS.
1. Download the [pre-built Mac application](https://github.com/lowerquality/gentle/releases/download/0.9.0/gentle-0.9.0.dmg). This package includes a GUI that will start the server and a browser. It only works on Mac OS.

2. Use the [Docker](https://www.docker.com/) image. Just run ```docker run -P lowerquality/gentle```. This works anywhere Docker is installed.
2. Use the [Docker](https://www.docker.com/) image. Just run ```docker run -P lowerquality/gentle```. This works on all platforms supported by Docker.

3. Download the source code and run ```./install.sh```. Then run ```python serve.py``` to start the server. This works on Mac and Linux.

## Using Gentle

By default, the aligner listens at http://localhost:8765. That page has a graphical interface for transcribing, viewing, and downloading audio.
By default, the aligner listens at http://localhost:8765. That page has a graphical interface for transcribing audio, viewing results, and downloading data.

There is also a REST API so you can use Gentle in your programs. Here's an example of how to use the API with CURL:

Expand Down
2 changes: 1 addition & 1 deletion gentle/__version__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '0.8.0'
__version__ = '0.9.0'

0 comments on commit 5c8340c

Please sign in to comment.