Add missing binary dependencies to Linux install documentaiton

[codingjoe]

Hi there 👋,

Love this work you are doing here. I noticed some binary dependencies were missing during the installation on a fresh Ubuntu image. PyAudio needs headers for portaudio and python to compile the wheel. I added instructions for apt (only works on Ubuntu) that should help most people. Users on other distros will probably be savvy enough to know how to adapt this to their package manager.

Cheers
Joe

Summary by CodeRabbit

• Documentation
  • Updated Linux installation instructions in the README to include additional required packages for setting up the environment.

[coderabbitai]

Walkthrough

The update enriches the Linux installation guide in the README file by specifying the inclusion of essential packages (python3-dev, python3-venv, portaudio19-dev) before initiating a virtual environment setup and installing the xtts-api-server. This ensures users have all the necessary dependencies installed for a smoother setup process.

Changes

File	Change Summary
README.md	Added commands for installing python3-dev, python3-venv, portaudio19-dev

🐇✨
In the realm of code, where scripts play their part,
A rabbit hopped by, with a README to impart.
Commands anew, for a setup refined,
Ensuring the path ahead is clearly defined.
Cheers to the changes, may they pave the way,
For a smoother journey in the coding array! 🌟📜

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1dab5e0 and 74da642.

Files selected for processing (1)

• README.md (1 hunks)

Additional Context Used

LanguageTool (52)

README.md (52)

Near line 1: Possible spelling mistake found.
Context: # A simple FastAPI Server to run XTTSv2 This project is i...

---

Near line 3: Possible spelling mistake found.
Context: ...un XTTSv2 This project is inspired by [silero-api-server](https://github.com/ouoertheo/silero-ap...

---

Near line 5: Possible spelling mistake found.
Context: ...-ai/TTS). This server was created for [SillyTavern](https://github.com/SillyTavern/SillyTa...

---

Near line 6: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...ern) but you can use it for your needs Feel free to make PRs or use the code for your own n...

---

Near line 11: Possible missing comma found.
Context: ...e looking for an option for normal XTTS use look here [https://github.com/daswer123...

---

Near line 11: Unpaired symbol: ‘]’ seems to be missing
Context: ...an option for normal XTTS use look here [https://github.com/daswer123/xtts-webui]...

---

Near line 13: Consider adding a comma after ‘Recently’ for more clarity.
Context: ...s://github.com/daswer123/xtts-webui) **Recently I have little time to do this project, ...

---

Near line 13: Unpaired symbol: ‘]’ seems to be missing
Context: ...o I advise you to get acquainted with a [similar project](https://github.com/erew...

---

Near line 17: Unpaired symbol: ‘]’ seems to be missing
Context: ...ou can keep track of all changes on the [release page](https://github.com/daswer1...

---

Near line 32: Don’t put a space after the opening parenthesis.
Context: ...U version** to improve processing speed ( up to 3 times faster ) ### Windows ```b...

---

Near line 32: Don’t put a space before the closing parenthesis.
Context: ... processing speed ( up to 3 times faster ) ### Windows ```bash python -m venv ven...

---

Near line 95: Possible spelling mistake found.
Context: ...-m xtts_api_serverwill run on default ip and port (localhost:8020) Use the--d...

---

Near line 97: Possible spelling mistake found.
Context: ...t ip and port (localhost:8020) Use the --deepspeed flag to process the result fast ( 2-3x...

---

Near line 97: Don’t put a space after the opening parenthesis.
Context: ...pspeed` flag to process the result fast ( 2-3x acceleration ) ``` usage: xtts_api...

---

Near line 97: Don’t put a space before the closing parenthesis.
Context: ...cess the result fast ( 2-3x acceleration ) ``` usage: xtts_api_server [-h] [-hs H...

---

Near line 126: Possible spelling mistake found.
Context: ...s, note in the folder should be 3 files config.json vocab.json model.pth If you want ...

---

Near line 126: Possible spelling mistake found.
Context: ... folder should be 3 files config.json vocab.json model.pth If you want your host to ...

---

Near line 128: Possible spelling mistake found.
Context: ... If you want your host to listen, use -hs 0.0.0.0 or use --listen The -t or --tu...

---

Near line 130: Unpaired symbol: ‘]’ seems to be missing
Context: ...ect link to hear the preview. More info here Mode...

---

Near line 132: Possible spelling mistake found.
Context: ...defines in which format you want to use xtts: 1. local - loads version 2.0.2 by d...

---

Near line 134: Possible spelling mistake found.
Context: ...l saves into the models folder and uses XttsConfig and inference. 2. apiManual - load...

---

Near line 135: Possible spelling mistake found.
Context: ...ves into the models folder and uses the tts_to_file function from the TTS api 3. `...

---

Near line 135: Possible spelling mistake found.
Context: ...the tts_to_file function from the TTS api 3. api - will load the latest version...

---

Near line 138: Possible typo: you repeated a whitespace
Context: .../huggingface.co/coqui/XTTS-v2/tree/main) the model version name is the same as th...

---

Near line 146: Unpaired symbol: ‘]’ seems to be missing
Context: ...ww.youtube.com/watch?v=jHylNGQDDA0) and [here](https://www.youtube.com/watch?v=6v...

---

Near line 150: To form a complete sentence, be sure to include a subject.
Context: ...uWcV3U) Now, about the limitations 1. Can only be used on a local computer 2. Pla...

---

Near line 151: A determiner cannot be combined with a possessive pronoun. Did you mean simply “the” or “your”?
Context: ... a local computer 2. Playing audio from the your pc 3. Does not work endpoint `tts_to_fi...

---

Near line 152: Only proper nouns start with an uppercase character (there are exceptions for headlines).
Context: ...er 2. Playing audio from the your pc 3. Does not work endpoint tts_to_file only `t...

---

Near line 152: Possible spelling mistake found.
Context: ...m the your pc 3. Does not work endpoint tts_to_file only tts_to_audio and it ret...

---

Near line 152: Possible spelling mistake found.
Context: ...es not work endpoint tts_to_file only tts_to_audio and it returns 1 second of si...

---

Near line 158: This sentence does not start with an uppercase letter.
Context: ...rocessing speech. --stream-play-sync flag - Allows you to play all messages in qu...

---

Near line 158: Possible spelling mistake found.
Context: ...rder, useful if you use group chats. In SillyTavern you need to turn off streaming to work ...

---

Near line 162: Unpaired symbol: ‘]’ seems to be missing
Context: ...API Docs API Docs can be accessed from [http://localhost:8020/docs](http://local...

---

Near line 165: Did you mean: “By default,”?
Context: ...lhost:8020/docs) # How to add speaker By default the speakers folder should appear in ...

---

Near line 166: Possible spelling mistake found.
Context: ...n the folder, you need to put there the wav file with the voice sample, you can als...

---

Near line 174: Unpaired symbol: ‘]’ seems to be missing
Context: ... The following post is a quote by user [Material1276 from reddit](https://www.re...

---

Near line 174: Possible spelling mistake found.
Context: ...t is a quote by user [Material1276 from reddit](https://www.reddit.com/r/Oobabooga/com...

---

Near line 178: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...making good samples > > Keep them about 7-9 seconds long. Longer isn't necessarily ...

---

Near line 180: Possible spelling mistake found.
Context: ... down sampled to a Mono, 22050Hz 16 Bit wav file. You will slow down processing by ...

---

Near line 180: Possible missing preposition found.
Context: ...wn processing by a large % and it seems cause poor quality results otherwise (based o...

---

Near line 182: This sentence does not start with an uppercase letter.
Context: ...Hz, then Tracks > Mix > Stereo to Mono. and then File > Export Audio, saving it as ...

---

Near line 186: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ...have background noises or music on e.g. lots of movies have quiet music when many of th...

---

Near line 186: Did you mean “hissed” or “to hiss”?
Context: ...re talking. Bad quality audio will have hiss that needs clearing up. The AI will pic...

---

Near line 188: The verb “make” needs to be in the to-infinitive form.
Context: ...some extent, so clean audio is key! > > Try make your clip one of nice flowing speech, l...

---

Near line 188: Unpaired symbol: ‘]’ seems to be missing
Context: ...ittle vocal range. Example files are in [here](https://github.com/oobabooga/text-...

---

Near line 190: In American English, abbreviations like “etc.” require a period.
Context: ...d with breathy sounds (breathing in/out etc). > > Using AI generated audio clips ma...

---

Near line 192: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ounds (breathing in/out etc). > > Using AI generated audio clips may introduce unwanted soun...

---

Near line 192: Did you mean “it's” (short for ‘it is’) instead of ‘its’ (possessive pronoun)?
Context: ... clips may introduce unwanted sounds as its already a copy/simulation of a voice, t...

---

Near line 196: Possible spelling mistake found.
Context: ...g. # Credit 1. Thanks to the author Kolja Beigel for the repository [RealtimeTT...

---

Near line 196: Possible spelling mistake found.
Context: ...or Kolja Beigel for the repository RealtimeTTS...

---

Near line 196: Put a space after the comma, but not before the comma.
Context: ...](https://github.com/KoljaB/RealtimeTTS) , I took some of its code for my project....

---

Near line 198: Possible spelling mistake found.
Context: ...code to download the models 3. Thanks lendot for helping to fix the multiprocessin...

Additional comments not posted (1)

README.md (1)

44-44: Ensure consistency in command format across different OS sections.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1