From b8a8cfba3b9fa31c6a189b9b9137087c79637f46 Mon Sep 17 00:00:00 2001 From: "Reece H. Dunn" Date: Tue, 24 Sep 2013 18:01:25 +0100 Subject: [PATCH] README.md: Add documentation on installing the needed build dependencies. --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 9b380902..752b8e7c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # eSpeak Text-to-Speech +- [Build Dependencies](#build-dependencies) + - [Debian](#debian) - [Building](#building) - [Testing](#testing) - [Installing](#installing) @@ -22,6 +24,31 @@ This does the following things: This branch also contains some bug fixes and improvements that get sent back upstream. +## Build Dependencies + +In order to build eSpeak, you need: + +1. a functional autotools system (`make`, `autoconf`, `automake`, `libtool` + and `pkg-config`); +2. a functional c++ compiler; +3. wxWidgets development libraries (needed to build and run espeakedit + to compile the phoneme data). + +Optionally, you need: + +1. the pulseaudio development library to enable pulseaudio output; +2. the portaudio development library to enable portaudio output. + +### Debian + +| Dependency | Install | +|---------------|------------------------------------------------------------------| +| autotools | `sudo apt-get install make autoconf automake libtool pkg-config` | +| c++ compiler | `sudo apt-get install gcc g++` | +| wxWidgets | `sudo apt-get install libwxgtk2.8-dev` | +| pulseaudio | `sudo apt-get install libpulse-dev` | +| portaudio | `sudo apt-get install libportaudio-dev` | + ## Building The espeak and espeakedit programs, along with the espeak voices, can