Skip to content

Commit

Permalink
Linted Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BennyRe committed Feb 11, 2016
1 parent f807774 commit bbfc283
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
This repository contains ROS packages for the CereProc CereVoice TTS engine.

## Installation
0.0 [Install ROS Hydro](http://wiki.ros.org/hydro/Installation/Ubuntu) (or maybe Indigo or J-Turtle in the future) if you haven't already.

0.0 [Install ROS Indigo](http://wiki.ros.org/indigo/Installation/Ubuntu) if you haven't already.
0.1 [Create a Catkin workspace](http://wiki.ros.org/catkin/Tutorials/create_a_workspace) if you don't already have one.

1. Clone the CereVoice SDK:
Expand All @@ -15,27 +16,31 @@ This repository contains ROS packages for the CereProc CereVoice TTS engine.
$ git clone [email protected]:ros/cerevoice_tts.git
$ catkin_make


## Running

```$ roslaunch cerevoice_tts tts.launch ```

You may have to modify the language file information in the launch file.

Always launch the node on the computer where the speakers are connected!

## Synthesizing text

The text in the goal will be put in XML format, so feel free to use XML or SSML tags in your text.
You do NOT have to provide the <xml> and <speak> tags. This is done automatically.
You do NOT have to provide the `<xml>` and `<speak>` tags. This is done automatically.

If you leave the voice parameter unset, the default voice will be used.

The default voice is the first voice specified in the launch file.

### From the command line

```$ rosrun actionlib axclient.py /TTS ```

There enter the name of the voice and the text.

### From within a ROS node

See the [ROS actionlib tutorial](http://wiki.ros.org/actionlib_tutorials/Tutorials/SimpleActionClient) for how to use actionlib.

Create the action client with
Expand All @@ -47,8 +52,8 @@ Set the voice and the text in the action goal with
goal.text = "Your text here.";
goal.voice = "Heather";


## Launch file format

Example:

<?xml version="1.0"?>
Expand All @@ -68,7 +73,6 @@ Example:
<node name="cerevoice_tts_node" pkg="cerevoice_tts" type="cerevoice_tts_node" respawn="false" output="screen" />
</launch>


The path and the license of a voice are required. Lexicon and abbreviations file are optional.
The optional string startup_sentence will be synthesized when the TTS node is ready.

Expand All @@ -81,5 +85,6 @@ To test text you can use the script txt2speech. It takes as an argument the path
usage: txt2speech [-h] [--voice Alex] path/file

Examples:

$ rosrun cerevoice_tts txt2speech text.txt
$ rosrun cerevoice_tts txt2speech.py --voice=Alex text.txt

0 comments on commit bbfc283

Please sign in to comment.