Skip to content

Latest commit

 

History

History
 
 

addon

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
awesometts
awesometts
 
 
tools
tools
 
 
AwesomeTTS.py
AwesomeTTS.py
 
 
LICENSE.txt
LICENSE.txt
 
 
README.md
README.md
 
 

README.md

AwesomeTTS Add-on

Once loaded into the Anki addons directory, the AwesomeTTS add-on code enables both on-demand playback and recording functionality.

Installation

There are a few different ways one can install the add-on code.

Stable Package

The AnkiWeb add-on page has the latest stable branch of the add-on, which can be installed directly within the Anki user interface using add-on code 301952613.

Development and Other Versions

The develop branch, hotfixes and previews, and specific releases can be downloaded from GitHub or pulled in and installed with git and a script. Please note that the script methods require access to a Unix-like shell, and the symlink method requires using a file system that supports it.

  • Manually from GitHub: Choose the specific branch or tagged release you want, and download the zip or tarball. Navigate into the addon directory in the archive, then extract AwesomeTTS.py and the awesometts/ subdirectory into the base of your Anki addons directory.

  • Straight Install: Copy the files into your Anki addons directory using the install.sh helper, removing any other installation of AwesomeTTS. If you have an existing configuration file, it will be saved, but your cache will be cleared.

      $ git clone https://github.com/AwesomeTTS/AwesomeTTS.git
  $ cd AwesomeTTS
  $ git checkout [ref]  (if not using "develop", e.g. v1.0.0-beta.10)
  $ addon/tools/install.sh [addons directory]  (e.g. ~/Anki/addons)

  • Using Symlinks for Development: Symlink the files into your Anki addons directory using the symlink.sh helper, removing any other installation of AwesomeTTS. If you have an existing configuration file, it will be saved, but your cache will be cleared unless your new symlink happens to have a cache directory.

      $ git clone https://github.com/AwesomeTTS/AwesomeTTS.git
  $ cd AwesomeTTS
  $ git checkout [ref]  (if not using "develop", e.g. v1.0.0-beta.10)
  $ addon/tools/symlink.sh [addons directory]  (e.g. ~/Anki/addons)

  • Package into a Zip File: Package the files into a zip archive for installation somewhere else using the package.sh helper. This is also how the package is built for AnkiWeb.

      $ git clone https://github.com/AwesomeTTS/AwesomeTTS.git
  $ cd AwesomeTTS
  $ git checkout [ref]  (if not using "develop", e.g. v1.0.0-beta.10)
  $ addon/tools/package.sh [zip target]  (e.g. ~/AwesomeTTS.zip)

License

AwesomeTTS is free and open-source software. The add-on code that runs within Anki is released under the GNU GPL v3.