Skip to content

Commit 7af858f

Browse files
etiktinjonathanslenders
authored andcommitted
Update README
Fixed some typos and phrasing.
1 parent f9bca69 commit 7af858f

File tree

1 file changed

+21
-25
lines changed

1 file changed

+21
-25
lines changed

README.rst

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ptpython
1313

1414
Ptpython is an advanced Python REPL. It should work on all
1515
Python versions from 2.6 up to 3.5 and work cross platform (Linux,
16-
BSD and OS X, Window).
16+
BSD, OS X and Windows).
1717

1818

1919
Installation
@@ -100,8 +100,8 @@ error.
100100
.. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/validation.png
101101
102102
103-
Other features
104-
**************
103+
Additional features
104+
*******************
105105

106106
Running system commands: Press ``Meta-!`` in Emacs mode or just ``!`` in Vi
107107
navigation mode to see the "Shell command" prompt. There you can enter system
@@ -111,7 +111,7 @@ Selecting text: Press ``Control+Space`` in Emacs mode on ``V`` (major V) in Vi
111111
navigation mode.
112112

113113

114-
Configurating
114+
Configuration
115115
*************
116116

117117
It is possible to create a ``~/.ptpython/config.py`` file to customize the configuration.
@@ -120,8 +120,8 @@ Have a look at this example to see what is possible:
120120
`config.py <https://github.com/jonathanslenders/ptpython/blob/master/examples/ptpython_config/config.py>`_
121121

122122

123-
You love IPython?
124-
*****************
123+
IPython support
124+
***************
125125

126126
Run ``ptipython`` (prompt_toolkit - IPython), to get a nice interactive shell
127127
with all the power that IPython has to offer, like magic functions and shell
@@ -131,8 +131,8 @@ ipython``)
131131
.. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/ipython.png
132132
133133
134-
You are using Django?
135-
*********************
134+
Django support
135+
**************
136136

137137
`django-extensions <https://github.com/django-extensions/django-extensions>`_
138138
has a ``shell_plus`` management command. When ``ptpython`` has been installed,
@@ -146,40 +146,36 @@ There is an experimental PDB replacement: `ptpdb
146146
<https://github.com/jonathanslenders/ptpdb>`_.
147147

148148

149-
About Windows support
150-
*********************
149+
Windows support
150+
***************
151151

152-
``prompt_toolkit`` and ``ptpython`` are better tested on Linux and OS X than on
153-
Windows, but it should be usable:
152+
``prompt_toolkit`` and ``ptpython`` works better on Linux and OS X than on
153+
Windows. Some things might not work, but it is usable:
154154

155155
.. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/windows.png
156156
157157
158158
FAQ
159-
---
159+
***
160160

161-
Q
162-
The ``Ctrl-S`` forward search doesn't work and freezes my terminal.
163-
A
164-
Try to run ``stty -ixon`` in your terminal to disable flow control.
161+
**Q**: The ``Ctrl-S`` forward search doesn't work and freezes my terminal.
165162

166-
Q
167-
The ``Meta``-key doesn't work.
168-
A
169-
For some terminals you have to enable the Alt-key to act as meta key, but you
170-
can also type ``Escape`` before any key instead.
163+
**A**: Try to run ``stty -ixon`` in your terminal to disable flow control.
164+
165+
**Q**: The ``Meta``-key doesn't work.
166+
167+
**A**: For some terminals you have to enable the Alt-key to act as meta key, but you
168+
can also type ``Escape`` before any key instead.
171169

172170

173171
Alternatives
174172
************
175173

176-
Have a look at the alternatives.
177-
178174
- `BPython <http://bpython-interpreter.org/downloads.html>`_
179175

180176
If you find another alternative, you can create an issue and we'll list it
181177
here. If you find a nice feature somewhere that is missing in ``ptpython``,
182-
also create a GitHub issue and mabye we'll implement it.
178+
also create a GitHub issue and maybe we'll implement it.
183179

184180

185181
Special thanks to

0 commit comments

Comments
 (0)