Skip to content

Commit a48e7f9

Browse files
committedDec 20, 2016
Update the docs a little bit
1 parent 16111ff commit a48e7f9

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed
 

‎.github/ISSUE_TEMPLATE.md

+2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ My **system** is <INSERT SYSTEM HERE>. (For example, "Ubuntu 16.04 LTS x64", "Wi
2828

2929
My **Python version** is <INSERT VERSION HERE>. (You can check this by running `python -V`.)
3030

31+
My **Pip version** is <INSERT VERSION HERE>. (You can check this by running `pip -V`.)
32+
3133
My **SpeechRecognition library version** is <INSERT VERSION HERE>. (You can check this by running `python -c "import speech_recognition as sr;print(sr.__version__)"`.)
3234

3335
My **PyAudio library version** is <INSERT VERSION HERE> / I don't have PyAudio installed. (You can check this by running `python -c "import pyaudio as p;print(p.__version__)"`.)

‎README.rst

+8-6
Original file line numberDiff line numberDiff line change
@@ -154,13 +154,15 @@ To install, use `Pip <https://pip.readthedocs.org/>`__: execute ``pip install mo
154154
Troubleshooting
155155
---------------
156156

157-
The recognizer tries to recognize speech even when I'm not speaking.
158-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
157+
The recognizer tries to recognize speech even when I'm not speaking, or after I'm done speaking.
158+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
159159

160160
Try increasing the ``recognizer_instance.energy_threshold`` property. This is basically how sensitive the recognizer is to when recognition should start. Higher values mean that it will be less sensitive, which is useful if you are in a loud room.
161161

162162
This value depends entirely on your microphone or audio data. There is no one-size-fits-all value, but good values typically range from 50 to 4000.
163163

164+
Also, check on your microphone volume settings. If it is too sensitive, the microphone may be picking up a lot of ambient noise. If it is too insensitive, the microphone may be rejecting speech as just noise.
165+
164166
The recognizer can't recognize speech right after it starts listening for the first time.
165167
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
166168

@@ -245,9 +247,9 @@ To hack on this library, first make sure you have all the requirements listed in
245247

246248
To install/reinstall the library locally, run ``python setup.py install`` in the project `root directory <https://github.com/Uberi/speech_recognition>`__.
247249

248-
Before a release, version tags are created using ``git config --global user.signingkey DB45F6C431DE7C2DCD99FF7904882258A4063489 && git tag -s VERSION_GOES_HERE -m VERSION_GOES_HERE``.
250+
Before a release, version tags are created using ``git config user.signingkey DB45F6C431DE7C2DCD99FF7904882258A4063489 && git tag -s VERSION_GOES_HERE -m "Version VERSION_GOES_HERE"``.
249251

250-
Releases are done by running either ``build.sh`` or ``build.bat``. These are bash and batch scripts, respectively, that automatically build Python source packages and `Python Wheels <http://pythonwheels.com/>`__, then upload them to PyPI.
252+
Releases are done by running ``build.sh`` to build the Python source packages, sign them, and upload them to PyPI.
251253

252254
Testing
253255
~~~~~~~
@@ -256,9 +258,9 @@ To run all the tests:
256258

257259
.. code:: bash
258260
259-
python -m unittest discover
261+
python -m unittest discover --verbose
260262
261-
Testing is also done automatically by TravisCI. To set up the environment for offline/local Travis-like testing on a Debian-like system:
263+
Testing is also done automatically by TravisCI, upon every push. To set up the environment for offline/local Travis-like testing on a Debian-like system:
262264

263265
.. code:: bash
264266

‎reference/pocketsphinx.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Once installed, you can simply specify the language using the ``language`` param
3030
Building PocketSphinx-Python from source
3131
----------------------------------------
3232

33-
For Windows, it is recommended to install the precompiled Wheel packages. These are provided because building Pocketsphinx on Windows requires a lot of work, and can take hours to download and install all the surrounding software.
33+
For Windows, it is recommended to install the precompiled Wheel packages in the ``third-party`` directory. These are provided because building Pocketsphinx on Windows requires a lot of work, and can take hours to download and install all the surrounding software.
3434

3535
For Linux and other POSIX systems (like OS X), you'll want to build from source. It should take less than two minutes on a fast machine.
3636

0 commit comments

Comments
 (0)