updated docs for voice-to-code

Aider-AI · Aug 11, 2023 · c2ac1f6 · c2ac1f6
1 parent 88f0ef3
commit c2ac1f6
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 2 deletions.
diff --git a/HISTORY.md b/HISTORY.md
@@ -1,8 +1,9 @@
 # Release history
 
-### main branch
+### v0.12.0
 
-- Fixed bug where /diff was causing crash
+- [Voice-to-code](https://aider.chat/docs/voice.html) support, which allows you to code with your voice.
+- Fixed bug where /diff was causing crash.
 - Improved prompting for gpt-4, refactor of editblock coder.
 - [Benchmarked](https://aider.chat/docs/benchmarks.html) at 63.2% for gpt-4/diff, no regression.
 

diff --git a/README.md b/README.md
@@ -28,6 +28,7 @@ Aider is unique in that it [works well with pre-existing, larger codebases](http
 - [Tips](#tips)
 - [GPT-4 vs GPT-3.5](https://aider.chat/docs/faq.html#gpt-4-vs-gpt-35)
 - [Installation](https://aider.chat/docs/install.html)
+- [Voice-to-code](https://aider.chat/docs/voice.html)
 - [FAQ](https://aider.chat/docs/faq.html)
 
 ## Getting started

diff --git a/docs/install.md b/docs/install.md
@@ -9,6 +9,7 @@ Optional steps:
 
 - [Install universal ctags (optional)](#install-universal-ctags-optional)
 - [Add aider to your editor (optional)](#add-aider-to-your-editor-optional)
+- [Install PortAudio (optional)](#install-portaudio-optional)
 
 ## pip install aider-chat
 
@@ -111,6 +112,18 @@ Exuberant Ctags 5.8, Copyright (C) 1996-2009 Darren Hiebert
   Optional compiled features: +wildcards, +regex, +gnulib_fnmatch, +gnulib_regex, +iconv, +option-directory, +xpath, +json, +interactive, +yaml, +case-insensitive-filenames, +packcc, +optscript, +pcre2
 ```
 
+## Install PortAudio (optional)
+
+Aider supports [coding with your voice](https://aider.chat/docs/voice.html)
+using the in-chat `/voice` command.
+Aider uses the [PortAudio](http://www.portaudio.com) library to
+capture audio.
+Installing PortAudio is completely optional, but can usually be accomplished like this:
+
+- For Windows, there is no need to install PortAudio.
+- For Mac, do `brew install portaudio`
+- For Linux, do `sudo apt-get install libportaudio2`
+
 ## Add aider to your editor (optional)
 
 [joshuavial](https://github.com/joshuavial) has been working on editor integrations.

diff --git a/docs/voice.md b/docs/voice.md
@@ -12,6 +12,9 @@ Your voice coding instructions will be transcribed
 and sent to GPT, as if you had manually typed them into
 the aider chat session.
 
+See the [installation instructions](https://aider.chat/docs/install.html#install-portaudio-optional) for
+instructions on how to enable the `/voice` command.
+
 <div class="chat-transcript" markdown="1">
 
 > Aider v0.11.2-dev