jamosdev
/
rhubarb-lip-sync
mirror of https://github.com/DanielSWolf/rhubarb-lip-sync.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation

This commit is contained in:
Daniel Wolf 2018-09-01 15:19:14 +02:00
parent 8648ed5640
commit 49097b00d7
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.adoc
View File

@ -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. 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. * 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 <<options,command-line options>> 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 <<options,command-line options>> 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. * 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]] [[options]]
@ -121,7 +121,7 @@ The following command-line options are the most common:
| Option | Description | Option | Description
| _<input file>_ | _<input file>_
| 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` _<format>_, `--exportFormat` _<format>_ | `-f` _<format>_, `--exportFormat` _<format>_
| The export format. Options: `tsv` (tab-separated values, see <<tsv,details>>), `xml` (see <<xml,details>>), `json` (see <<json,details>>). | The export format. Options: `tsv` (tab-separated values, see <<tsv,details>>), `xml` (see <<xml,details>>), `json` (see <<json,details>>).

7
VERSION.md
View File

@ -1,8 +1,9 @@
# Version history # 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 ## Version 1.7.2
@ -11,7 +12,7 @@
## Version 1.7.1 ## Version 1.7.1
* Fixed [issue #34](https://github.com/DanielSWolf/rhubarb-lip-sync/issues/34): Generic error message in Rhubarb for Spine * 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 * Internal errors in Rhubarb Lip Sync for Spine are logged to stderr
## Version 1.7.0 ## Version 1.7.0