| Hash | Commit message | Author | Date | Files | + | - |
|---|
| 1 | commit 179d11793f3dafd2f988ba5d3fb2e2b080eb60ba |
| 2 | Author: Connor Etherington <[email protected]> |
| 3 | Date: Tue Aug 1 23:33:26 2023 +0200 |
| 4 | |
| 5 | Auto-Commit Update 01.08.2023 - 23:33:26 |
| 6 | --- |
| 7 | LICENSE | 24 ++++++++++++++++++++++++ |
| 8 | README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ |
| 9 | 2 files changed, 71 insertions(+) |
| 10 | |
| 11 | diff --git a/LICENSE b/LICENSE |
| 12 | new file mode 100644 |
| 13 | index 0000000..b147493 |
| 14 | --- /dev/null |
| 15 | +++ b/LICENSE |
| 16 | @@ -0,0 +1,24 @@ |
| 17 | +MIT/X Consortium License |
| 18 | + |
| 19 | +Creator /Maintainer : |
| 20 | +© Connor Etherington <[email protected]> |
| 21 | +--------------------------------------------------------------------------- |
| 22 | + |
| 23 | +Permission is hereby granted, free of charge, to any person obtaining a copy |
| 24 | +of this software and associated documentation files (the "Software"), to deal |
| 25 | +in the Software without restriction, including without limitation the rights |
| 26 | +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 27 | +copies of the Software, and to permit persons to whom the Software is |
| 28 | +furnished to do so, subject to the following conditions: |
| 29 | + |
| 30 | +THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN ALL |
| 31 | +COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. |
| 32 | + |
| 33 | + |
| 34 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 35 | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 36 | +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 37 | +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 38 | +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 39 | +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 40 | +SOFTWARE. |
| 41 | diff --git a/README.md b/README.md |
| 42 | new file mode 100644 |
| 43 | index 0000000..a3c3ce3 |
| 44 | --- /dev/null |
| 45 | +++ b/README.md |
| 46 | @@ -0,0 +1,47 @@ |
| 47 | +# Saywoof - BARK Text-to-Speech Wrapper |
| 48 | + |
| 49 | +### Welcome to Saywoof, an easy to use wrapper for the BARK text-to-speech engine. The library provides a simple set of functions to quickly get started with Bark TTS. |
| 50 | + |
| 51 | +*Version: 0.1.0* |
| 52 | + |
| 53 | +*** |
| 54 | + |
| 55 | + |
| 56 | +## Installation: |
| 57 | + |
| 58 | +### **Saywoof** can easily be installed from various platforms: |
| 59 | + |
| 60 | +### **PyPI**: |
| 61 | + pip install saywoof |
| 62 | + |
| 63 | +### **Conda**: |
| 64 | + conda install -c concise saywoof |
| 65 | + |
| 66 | +### **From Source**: |
| 67 | +#### If you prefer to install from source, clone this repo, cd into it and run: |
| 68 | + pip install -e . |
| 69 | + |
| 70 | + # or python3 ./setup.py install |
| 71 | + |
| 72 | + |
| 73 | +# Usage |
| 74 | + |
| 75 | +## Options: |
| 76 | ++ -h, --help: Show help message and exit. |
| 77 | ++ -l, --local: Load local model. |
| 78 | ++ -L, --large: Load large model. |
| 79 | ++ -s, --save: Save model. |
| 80 | ++ -t, --text: Text to convert to speech. |
| 81 | ++ -f, --file: File to convert to speech. |
| 82 | ++ -o, --output: Output file name. |
| 83 | ++ -r, --rate: Sample rate of output file. |
| 84 | ++ -p, --persistent: Persistent mode. |
| 85 | + |
| 86 | + |
| 87 | +## License |
| 88 | +Saywoof is open source and licenced under the MIT/X Consortium license |
| 89 | + |
| 90 | +## Support |
| 91 | +If you encounter any problems or have suggestions for Saywoof, please open an issue on GitLab. We value your feedback and will respond as quickly as possible. |
| 92 | + |
| 93 | + |