Updated docs

sguzman · Feb 28, 2017 · 813ecfc · 813ecfc
1 parent 538ca89
commit 813ecfc
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ in several formats, depending on its application:
 ### System Requirements
 
 1. a reasonably recent machine (recommended 4 GB RAM, 2 GHz 64bit CPU)
-2. [Python](https://python.org/) 2.7 (Linux, OS X, Windows) or 3.4 or later (Linux, OS X)
+2. [Python](https://python.org/) 2.7 (Linux, OS X, Windows) or 3.5 or later (Linux, OS X)
 3. [FFmpeg](https://www.ffmpeg.org/)
 4. [eSpeak](http://espeak.sourceforge.net/)
 5. Python packages `BeautifulSoup4`, `lxml`, and `numpy`

diff --git a/README.rst b/README.rst
@@ -75,7 +75,7 @@ System Requirements
 ~~~~~~~~~~~~~~~~~~~
 
 1. a reasonably recent machine (recommended 4 GB RAM, 2 GHz 64bit CPU)
-2. `Python <https://python.org/>`__ 2.7 (Linux, OS X, Windows) or 3.4 or
+2. `Python <https://python.org/>`__ 2.7 (Linux, OS X, Windows) or 3.5 or
    later (Linux, OS X)
 3. `FFmpeg <https://www.ffmpeg.org/>`__
 4. `eSpeak <http://espeak.sourceforge.net/>`__

diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -11,6 +11,7 @@ v1.7.2 (2017-03-03)
 #. Fixed a latent bug with arbitrary shifts in aba when using the ``task_adjust_boundary_no_zero`` option
 #. Fixed a latent bug in AWS Polly and Nuance wrappers
 #. Updated copyright strings with 2017
+#. Updated ``INSTALL.md`` to brew install from Daniel Bair's tap instead of official brew repo since they removed the formula for aeneas (#165)
 
 v1.7.1 (2016-12-20)
 -------------------

diff --git a/wiki/HOWITWORKS.md b/wiki/HOWITWORKS.md
@@ -60,7 +60,7 @@ first try to recognize what the speaker says,
 then they align the recognized text with the ground truth text,
 producing the final text-to-audio synchronization map.
 
-Unlike ASRs, 
+Unlike ASRs,
 **aeneas** uses a **more classic, signal-processing-based approach**,
 called [**Dynamic Time Warping**](https://en.wikipedia.org/wiki/Dynamic_time_warping) (DTW)
 leveraging text-to-speech (TTS) synthesis.
@@ -86,7 +86,7 @@ but you must bear in mind that
 **aeneas** actually operates on `C`,
 that is, the mono WAVE version of `R`.
 
-**NOTE**: 
+**NOTE**:
 The above observation is true
 for all the modern audio formats,
 considered at "file level".
@@ -301,7 +301,7 @@ M = [
     "His tender heir might bear his memory:"         -> [11.920, 15.280]
     ...
     "To eat the world's due, by the grave and thee." -> [48.080, 53.240]
-]         
+]
 ```
 
 ![Waveform with aligned labels, detail](align.png)

diff --git a/wiki/INSTALL.md b/wiki/INSTALL.md
@@ -45,12 +45,12 @@ Below you can find detailed procedures for each operating system.
     containing the C headers (`python-dev` or similar).
 
 2. Install `aeneas` system-wise with `pip`:
-    
+
     ```bash
     $ sudo pip install numpy
     $ sudo pip install aeneas
     ```
-    
+
     **Note**: you must install `numpy` before `aeneas`,
     otherwise the setup process will fail.
 
@@ -96,7 +96,7 @@ you can install all the dependencies by downloading and running
     and you can confidently run **aeneas** in production.
 
 3. In alternative to the previous point, you can install `aeneas` with `pip`:
-    
+
     ```bash
     $ sudo pip install numpy
     $ sudo pip install aeneas
@@ -148,9 +148,16 @@ Feel free to jump to step 3 if you already have `brew` installed in your system.
 4. Install `aeneas`:
 
     ```bash
-    $ brew install homebrew/python/aeneas
+    $ brew install danielbair/tap/aeneas
     ```
 
+    **NOTE** (2017-02-28): apparently the `brew` formula for `aeneas` has been removed
+    from the official `brew` repository
+    (it was installable with `brew install homebrew/python/aeneas`),
+    when the `homebrew-python` repository was deprecated.
+    While we try to upload the formula for `aeneas` back to the official repository,
+    you can use the tap by Daniel Bair to install `aeneas`.
+
 ### Manual Procedure
 
 Feel free to jump to step 9 if you already have
@@ -212,7 +219,7 @@ Feel free to jump to step 9 if you already have
     ```bash
     $ which python
     /usr/local/bin/python
-    
+
     $ python --version
     Python 2.7.10 (or later)
     ```
@@ -232,7 +239,7 @@ Feel free to jump to step 9 if you already have
     and you can confidently run **aeneas** in production.
 
 10. In alternative to the previous point, you can install `aeneas` with `pip`:
-    
+
     ```bash
     $ sudo pip install numpy
     $ sudo pip install aeneas
@@ -284,7 +291,7 @@ that you can download from
 ### Manual Procedure
 
 On Windows it is recommended to run **aeneas**
-with Python 2.7, since compiling the C extensions on Python 3.4 or 3.5
+with Python 2.7, since compiling the C extensions on Python 3.5
 requires [a complex setup process](http://stackoverflow.com/questions/29909330/microsoft-visual-c-compiler-for-python-3-4).
 
 The following guide was kindly provided by Richard Margetts of [SIL International](http://www.sil.org),
@@ -343,7 +350,7 @@ otherwise the modification will not be in effect.)
 1. Go to [http://ffmpeg.zeranoe.com/builds/](http://ffmpeg.zeranoe.com/builds/) .
 2. Download the `Static` version, 64-bit or 32-bit, depending on your system.
    You do not need the `Shared` or `Dev` versions.
-3. Unzip it to a new folder `C:\sync\ffmpeg`. 
+3. Unzip it to a new folder `C:\sync\ffmpeg`.
 4. Add the `C:\sync\ffmpeg\bin` path to your system `PATH` variable, as you did for eSpeak above.
    Do not forget the `bin` part of the path.
    The `bin` sub-folder contains three executables: `ffmpeg.exe`, `ffplay.exe`, and `ffprobe.exe` which are used by aeneas.

diff --git a/wiki/PLATFORMS.md b/wiki/PLATFORMS.md
@@ -1,35 +1,35 @@
-# Tested Platforms 
+# Tested Platforms
 
 **aeneas** has been confirmed to work on the following systems:
 
-| OS                | 32/64 bit | Python 2.7 | Python 3.4/3.5 | PyPy 5.x |
-|-------------------|-----------|------------|----------------|----------|
-| Arch              | 64        | Yes        | Yes            | Unknown  |
-| Debian            | 32        | Yes        | Yes            | Unknown  |
-| Debian            | 64        | Yes        | Yes            | Yes      |
-| Ubuntu            | 64        | Yes        | Yes            | Yes      |
-| Gentoo            | 64        | Yes        | Unknown        | Unknown  |
-| Slackware         | 64        | Yes        | Unknown        | Unknown  |
-| Mac OS X 10.7 (3) | 64        | Yes        | Yes            | Unknown  |
-| Mac OS X 10.8 (3) | 64        | Yes        | Yes            | Unknown  |
-| Mac OS X 10.9     | 64        | Yes        | Yes            | Unknown  |
-| Mac OS X 10.10    | 64        | Yes        | Yes            | Unknown  |
-| Mac OS X 10.11    | 64        | Yes        | Yes            | Unknown  |
-| Mac OS X 10.12    | 64        | Yes        | Yes            | Yes      |
-| Windows Vista     | 32        | Yes (1)    | Yes (1, 2)     | Unknown  |
-| Windows 7         | 32        | Yes (1)    | Yes (1, 2)     | Unknown  |
-| Windows 7         | 64        | Yes (1)    | Yes (1, 2)     | Unknown  |
-| Windows 8.1       | 32        | Yes (1)    | Yes (1, 2)     | Unknown  |
-| Windows 8.1       | 64        | Yes (1)    | Yes (1, 2)     | Unknown  |
-| Windows 10        | 64        | Yes (1)    | Yes (1, 2)     | Unknown  |
+| OS                | 32/64 bit | Python 2.7 | Python 3.5 | PyPy 5.x |
+|-------------------|-----------|------------|------------|----------|
+| Arch              | 64        | Yes        | Yes        | Unknown  |
+| Debian            | 32        | Yes        | Yes        | Unknown  |
+| Debian            | 64        | Yes        | Yes        | Yes      |
+| Ubuntu            | 64        | Yes        | Yes        | Yes      |
+| Gentoo            | 64        | Yes        | Unknown    | Unknown  |
+| Slackware         | 64        | Yes        | Unknown    | Unknown  |
+| Mac OS X 10.7 (3) | 64        | Yes        | Yes        | Unknown  |
+| Mac OS X 10.8 (3) | 64        | Yes        | Yes        | Unknown  |
+| Mac OS X 10.9     | 64        | Yes        | Yes        | Unknown  |
+| Mac OS X 10.10    | 64        | Yes        | Yes        | Unknown  |
+| Mac OS X 10.11    | 64        | Yes        | Yes        | Unknown  |
+| Mac OS X 10.12    | 64        | Yes        | Yes        | Yes      |
+| Windows Vista     | 32        | Yes (1)    | Yes (1, 2) | Unknown  |
+| Windows 7         | 32        | Yes (1)    | Yes (1, 2) | Unknown  |
+| Windows 7         | 64        | Yes (1)    | Yes (1, 2) | Unknown  |
+| Windows 8.1       | 32        | Yes (1)    | Yes (1, 2) | Unknown  |
+| Windows 8.1       | 64        | Yes (1)    | Yes (1, 2) | Unknown  |
+| Windows 10        | 64        | Yes (1)    | Yes (1, 2) | Unknown  |
 
 **Notes**
 
 (1) The ``cew`` Python C extension to speed up text synthesis
 with eSpeak is available on Linux, Mac OS X,
 and Windows 32 bit at the moment.
 
-(2) On Windows and Python 3.4/3.5, compiling the Python C extensions
+(2) On Windows and Python 3.5, compiling the Python C extensions
 is quite complex; however, running **aeneas** in pure Python mode
 has been confirmed to work.
 

diff --git a/wiki/PYINSTALLER.md b/wiki/PYINSTALLER.md
@@ -90,6 +90,6 @@ Important notes (for both cases):
     ```
 
 6. Distribute the file(s) created in the ``dist/`` directory.
-    
+
 
 
diff --git a/wiki/TESTING.md b/wiki/TESTING.md
@@ -1,4 +1,4 @@
-# Testing 
+# Testing
 
 The unit and integration tests are contained in the
 [``aeneas.tests``](https://github.com/readbeyond/aeneas/blob/master/aeneas/tests/)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -90,6 +90,6 @@ Important notes (for both cases):
		```

		6. Distribute the file(s) created in the ``dist/`` directory.