From 49097b00d79097e5d0cc757a4a7eedf0fe55ea95 Mon Sep 17 00:00:00 2001 From: Daniel Wolf Date: Sat, 1 Sep 2018 15:19:14 +0200 Subject: [PATCH] Update documentation --- README.adoc | 4 ++-- VERSION.md | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.adoc b/README.adoc index 43750e1..fb08c03 100644 --- a/README.adoc +++ b/README.adoc @@ -106,7 +106,7 @@ This shape is also used as an in-between when animating from {C} or {D} to {F}. Rhubarb Lip Sync is a command-line tool that is currently available for Windows and OS X. * Download the https://github.com/DanielSWolf/rhubarb-lip-sync/releases[latest release] and unzip the file anywhere on your computer. -* Call `rhubarb`, passing it a WAVE file as argument and telling it where to create the output file. In its simplest form, this might look like this: `rhubarb -o output.txt my-recording.wav`. There are additional <> you can specify in order to get better results. +* Call `rhubarb`, passing it an audio file as argument and telling it where to create the output file. In its simplest form, this might look like this: `rhubarb -o output.txt my-recording.wav`. There are additional <> you can specify in order to get better results. * Rhubarb Lip Sync will analyze the sound file, animate it, and create an output file containing the animation. If an error occurs, Rhubarb Lip Sync will instead print an error message to `stderr` and exit with a non-zero exit code. [[options]] @@ -121,7 +121,7 @@ The following command-line options are the most common: | Option | Description | __ -| The audio file (.wav format) to be analyzed. This must be the last command-line argument. +| The audio file to be analyzed. This must be the last command-line argument. Supported file formats are WAVE (.wav) and Ogg Vorbis (.ogg). | `-f` __, `--exportFormat` __ | The export format. Options: `tsv` (tab-separated values, see <>), `xml` (see <>), `json` (see <>). diff --git a/VERSION.md b/VERSION.md index 7ae859d..2998a1b 100644 --- a/VERSION.md +++ b/VERSION.md @@ -1,8 +1,9 @@ # Version history -## Unreleased +## Version 1.8.0 -* Support for Ogg Vorbis (.ogg) files +* Support for Ogg Vorbis (.ogg) file format ([issue #40](https://github.com/DanielSWolf/rhubarb-lip-sync/issues/40)) +* Fixed build error with some versions of Boost ([issue #41](https://github.com/DanielSWolf/rhubarb-lip-sync/issues/41)) ## Version 1.7.2 @@ -11,7 +12,7 @@ ## Version 1.7.1 * Fixed [issue #34](https://github.com/DanielSWolf/rhubarb-lip-sync/issues/34): Generic error message in Rhubarb for Spine -* More helpful error dialogs for internal errors in Rhubarb Lip Sync for Spine +* More helpful error dialogs for internal errors in Rhubarb Lip Sync for Spine * Internal errors in Rhubarb Lip Sync for Spine are logged to stderr ## Version 1.7.0