Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
n0spaces committed May 29, 2021
1 parent ca0a878 commit 694c325
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,41 @@ concatenates the segments of Morshu's audio where he speaks those phonemes.
## Requirements
Python 3.7+ (tested on Windows, should also work on Linux and macOS)

Python is not required if you're just using the MorshuTalk executable.

## Installation
You can install this with `pip`:
### Windows Executable
If you're on Windows and you don't want to install Python, you can download an executable from the
[latest release on GitHub](https://github.com/n0spaces/MorshuTalk/releases/latest). Simply download the 7z or ZIP
archive (they're both identical) and extract it.

### Python Package
If you have Python installed, you can install this with `pip`:

pip install morshutalk

You can also download the wheel package manually and install that:
Or you can clone this repo and run the setup script:

pip install MorshuTalk-x.x.x-py3-none-any.whl
python setup.py install

This installs all the packages necessary for running MorshuTalk from the command-line. If you want to use the GUI, you
will also need to install PySide6. (It's not included by default because it's a slightly larger download.)

pip install PySide6

## Running
### Windows Executable
Just run `MorshuTalk.exe` to start the GUI.

### Python Package
Installing the package will add the commands `morshutalk` and `morshutalkgui` to your command-line. If those commands
don't work, you can run the modules with `python -m morshutalk` or `python -m morshutalkgui`.

### Command-Line
#### Command-Line
Run `morshutalk` to load the interactive command-line app. Simply type whatever lines you want Morshu to speak, then he
will talk. To exit, leave the line blank and hit enter.

### GUI
#### GUI
Run `morshutalkgui` to load the GUI app. Remember that PySide6 is required.

Type text into the textbox, then click Load to load the audio. Click Play to hear the audio. The Morshu sprite will
Expand Down Expand Up @@ -64,6 +76,7 @@ pyside6-rcc morshutalkgui\res\res.qrc -o morshutalkgui\res_rc.py

This uses the following libraries:
* [g2p_en](https://pypi.org/project/g2p-en/)
* [NumPy](https://numpy.org/)
* [Pydub](http://pydub.com/)
* [sounddevice](https://pypi.org/project/sounddevice/)
* [PySide 6 (Qt for Python)](https://wiki.qt.io/Qt_for_Python)

0 comments on commit 694c325

Please sign in to comment.