| - [Windows](#windows) | - [Windows](#windows) | ||||
| - [Binaries](#binaries) | - [Binaries](#binaries) | ||||
| - [Building](#building) | - [Building](#building) | ||||
| - [Build Dependencies](#build-dependencies) | |||||
| - [Building](#building-1) | |||||
| - [Audio Output Configuration](#audio-output-configuration) | |||||
| - [eSpeak NG Feature Configuration](#espeak-ng-feature-configuration) | |||||
| - [Extended Dictionary Configuration](#extended-dictionary-configuration) | |||||
| - [Testing](#testing) | |||||
| - [Installing](#installing) | |||||
| - [Linux, Mac, BSD](#linux-mac-bsd) | |||||
| - [Dependencies](#dependencies) | |||||
| - [Building](#building-1) | |||||
| - [Audio Output Configuration](#audio-output-configuration) | |||||
| - [eSpeak NG Feature Configuration](#espeak-ng-feature-configuration) | |||||
| - [Extended Dictionary Configuration](#extended-dictionary-configuration) | |||||
| - [Testing](#testing) | |||||
| - [Installing](#installing) | |||||
| - [Documentation](#documentation) | - [Documentation](#documentation) | ||||
| - [Notes for Packagers](#notes-for-packagers) | - [Notes for Packagers](#notes-for-packagers) | ||||
| - [eSpeak for Android](#espeak-for-android) | - [eSpeak for Android](#espeak-for-android) | ||||
| You can then open and build the `src/windows/espeak-ng.sln` solution in Visual | You can then open and build the `src/windows/espeak-ng.sln` solution in Visual | ||||
| Studio. | Studio. | ||||
| ## Build Dependencies | |||||
| ## Linux, Mac, BSD | |||||
| ### Dependencies | |||||
| In order to build eSpeak NG, you need: | In order to build eSpeak NG, you need: | ||||
| | ronn | `sudo apt-get install ruby-ronn` | | | ronn | `sudo apt-get install ruby-ronn` | | ||||
| | kramdown | `sudo apt-get install ruby-kramdown` | | | kramdown | `sudo apt-get install ruby-kramdown` | | ||||
| ## Building | |||||
| ### Building | |||||
| The first time you build eSpeak NG, or when you want to change how to build | The first time you build eSpeak NG, or when you want to change how to build | ||||
| eSpeak NG, you need to run the following standard autotools commands: | eSpeak NG, you need to run the following standard autotools commands: | ||||
| be found in the [Adding or Improving a Language](docs/add_language.md) | be found in the [Adding or Improving a Language](docs/add_language.md) | ||||
| documentation. | documentation. | ||||
| ### Audio Output Configuration | |||||
| #### Audio Output Configuration | |||||
| The following `configure` options control which audio interfaces to use: | The following `configure` options control which audio interfaces to use: | ||||
| which one to use at runtime, trying pulseaudio first before falling back to | which one to use at runtime, trying pulseaudio first before falling back to | ||||
| portaudio. | portaudio. | ||||
| ### eSpeak NG Feature Configuration | |||||
| #### eSpeak NG Feature Configuration | |||||
| The following `configure` options control which eSpeak NG features are enabled: | The following `configure` options control which eSpeak NG features are enabled: | ||||
| __NOTE:__ The `--with-sonic` option requires that the sonic library and header | __NOTE:__ The `--with-sonic` option requires that the sonic library and header | ||||
| is accessible on the system. | is accessible on the system. | ||||
| ### Extended Dictionary Configuration | |||||
| #### Extended Dictionary Configuration | |||||
| The following `configure` options control which of the extended dictionary files | The following `configure` options control which of the extended dictionary files | ||||
| to build: | to build: | ||||
| provide better coverage for those languages, while increasing the resulting | provide better coverage for those languages, while increasing the resulting | ||||
| dictionary size. | dictionary size. | ||||
| ## Testing | |||||
| ### Testing | |||||
| Before installing, you can test the built espeak-ng using the following command | Before installing, you can test the built espeak-ng using the following command | ||||
| from the top-level directory of this project: | from the top-level directory of this project: | ||||
| `src` directory and not the one on the system (which could be an older | `src` directory and not the one on the system (which could be an older | ||||
| version). | version). | ||||
| ## Installing | |||||
| ### Installing | |||||
| You can install eSpeak NG by running the following command: | You can install eSpeak NG by running the following command: | ||||