Skip to content
This repository was archived by the owner on Jun 27, 2023. It is now read-only.

Commit f8dbb35

Browse files
committed
Fix readme
1 parent 9c82751 commit f8dbb35

File tree

1 file changed

+38
-27
lines changed

1 file changed

+38
-27
lines changed

README.rst

Lines changed: 38 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
*******************
12
pocketsphinx-python
2-
===================
3+
*******************
34

45
.. image:: https://img.shields.io/pypi/v/pocketsphinx.svg
56
:target: https://pypi.python.org/pypi/pocketsphinx
@@ -26,42 +27,48 @@ Pocketsphinx packages include python support, however, it is based on Automake a
2627

2728
This package provides module created with Python distutils setup and can be more portable.
2829

30+
===================
2931
Supported Platforms
30-
-------------------
32+
===================
3133

3234
* Windows 7
3335
* Windows 8
3436
* Ubuntu 14.04
3537

38+
===================
3639
Install on Windows
37-
------------------
40+
===================
3841

42+
------------
3943
Requirements
40-
~~~~~~~~~~~~
44+
------------
4145

4246
* `Python <http://aka.ms/vcpython27>`__
4347
* `git <http://git-scm.com/downloads>`__
4448
* `Swig <http://www.swig.org/download.html>`__
4549
* `Microsoft Visual C++ Compiler for Python 2.7 <http://aka.ms/vcpython27>`__
4650

51+
-------
4752
Install
48-
~~~~~~~
53+
-------
4954

50-
.. code:: bash
51-
pip install pocketsphinx
55+
.. code-block:: bash
5256
53-
or
57+
# From pip
58+
$ pip install pocketsphinx
5459
55-
.. code:: bash
56-
git clone --recursive https://github.com/bambocher/pocketsphinx-python
57-
cd pocketsphinx-python
58-
python setup.py install
60+
# From source
61+
$ git clone --recursive https://github.com/bambocher/pocketsphinx-python
62+
$ cd pocketsphinx-python
63+
$ python setup.py install
5964
65+
=================
6066
Install on Ubuntu
61-
-----------------
67+
=================
6268

69+
------------
6370
Requirements
64-
~~~~~~~~~~~~
71+
------------
6572

6673
* python
6774
* python-dev
@@ -70,25 +77,28 @@ Requirements
7077
* swig
7178
* git
7279

80+
-------
7381
Install
74-
~~~~~~~
82+
-------
7583

76-
.. code:: bash
77-
sudo apt-get install -qq python python-dev python-pip build-essential swig
78-
sudo pip install pocketsphinx
84+
.. code-block:: bash
7985
80-
or
86+
# From pip
87+
$ sudo apt-get install -qq python python-dev python-pip build-essential swig
88+
$ sudo pip install pocketsphinx
8189
82-
.. code:: bash
83-
sudo apt-get install -qq python python-dev python-pip build-essential swig git
84-
git clone --recursive https://github.com/bambocher/pocketsphinx-python
85-
cd pocketsphinx-python
86-
sudo python setup.py install
90+
# From source
91+
$ sudo apt-get install -qq python python-dev python-pip build-essential swig git
92+
$ git clone --recursive https://github.com/bambocher/pocketsphinx-python
93+
$ cd pocketsphinx-python
94+
$ sudo python setup.py install
8795
96+
===========
8897
Basic usage
89-
-----------
98+
===========
99+
100+
.. code-block:: python
90101
91-
.. code:: python
92102
#!/usr/bin/env python
93103
import os
94104
@@ -119,7 +129,8 @@ Basic usage
119129
stream.close()
120130
print('Best hypothesis segments:', [seg.word for seg in decoder.seg()])
121131
132+
=======
122133
License
123-
-------
134+
=======
124135

125136
`The BSD License <https://github.com/bambocher/pocketsphinx-python/blob/master/LICENSE>`__

0 commit comments

Comments
 (0)