From 694c32513263a4798512c13b476c9a1362cc47e4 Mon Sep 17 00:00:00 2001 From: Matt Schwartz <7495188+n0spaces@users.noreply.github.com> Date: Sat, 29 May 2021 17:23:57 -0500 Subject: [PATCH] Update README --- README.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 77bf231..0c79085 100644 --- a/README.md +++ b/README.md @@ -10,14 +10,22 @@ 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.) @@ -25,14 +33,18 @@ will also need to install PySide6. (It's not included by default because it's a 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 @@ -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)