Skip to content

Commit 68dbae1

Browse files
committed
Begin update README.
1 parent bda0b92 commit 68dbae1

File tree

1 file changed

+23
-24
lines changed

1 file changed

+23
-24
lines changed

README.rst

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,30 @@
44
.. image:: https://travis-ci.org/klen/python-mode.png?branch=develop
55
:target: https://travis-ci.org/klen/python-mode
66

7-
Python-mode is a vim plugin that helps you to
8-
create python code very quickly by utilizing libraries including
9-
pylint_, rope_, pydoc_, pyflakes_, pep8_, and mccabe_
10-
for features like static analysis, refactoring, folding,
11-
completion, documentation, and more.
7+
Python-mode is a vim plugin that helps you to create python code very quickly
8+
by utilizing libraries including pylint_, rope_, pydoc_, pyflakes_, pep8_, and
9+
mccabe_ for features like static analysis, refactoring, folding, completion,
10+
documentation, and more.
1211

13-
There is no need to install pylint_, rope_
14-
or any other Python libraries on your system.
12+
There is no need to install pylint_, rope_ or any other Python libraries on
13+
your system.
1514

16-
- `Python motions and operators`_ (``]]``, ``3[[``, ``]]M``, ``vaC``, ``viM``, ``daC``, ``ciM``, ...)
17-
- `Python code folding`_
18-
- `Virtualenv support`_
15+
- `Support Python version 2 and 3`_
1916
- `Syntax highlighting`_
20-
- Highlight and auto fix unused imports
21-
- Many static analysis linters (pylint_, pyflakes_, pylama_, ...) that can be run simultaneously
17+
- `Virtualenv support`_
18+
- `Run python code`_ (``<leader>r``)
19+
- `Add/remove breakpoints`_ (``<leader>b``)
20+
- `Improved Python indentation`_
21+
- `Python folding`_
22+
- `Python motions and operators`_ (``]]``, ``3[[``, ``]]M``, ``vaC``, ``viM``, ``daC``, ``ciM``, ...)
23+
- `Code checking`_ (pylint_, pyflakes_, pylama_, ...) that can be run simultaneously (``:PymodeLint``)
24+
- `Autofix PEP8 errors`_ (``:PymodeLintAuto``)
25+
- `Search in python documentation`_ (``K``)
2226
- `Code refactoring <rope refactoring library>`_ (rope_)
23-
- Strong code completion (rope_)
24-
- Go to definition (``<C-c>g`` for `:RopeGotoDefinition`)
25-
- `Show documentation`_ (``K``)
26-
- Run python code (``<leader>r``)
27-
- Powerful customization settings_
27+
- `Strong code completion`_ (rope_)
28+
- `Go to definition` (``<C-c>g`` for `:RopeGotoDefinition`)
2829
- And more, more ...
2930

30-
3131
See (very old) screencast here: http://www.youtube.com/watch?v=67OZNp9Z0CQ (sorry for quality, this is my first screencast)
3232
Another old presentation here: http://www.youtube.com/watch?v=YhqsjUUHj6g
3333

@@ -40,15 +40,13 @@ Another old presentation here: http://www.youtube.com/watch?v=YhqsjUUHj6g
4040
Requirements
4141
============
4242

43-
- VIM >= 7.0 with python support
43+
- VIM >= 7.3 (mostly features needed `+python` or `+python3` support)
4444
(also ``--with-features=big`` if you want ``g:pymode_lint_signs``)
4545

4646

47-
4847
How to install
4948
==============
5049

51-
5250
Using pathogen (recomended)
5351
----------------------------
5452
::
@@ -93,10 +91,11 @@ Troubleshooting
9391

9492
If your python-mode doesn't work: open any python file and type: ::
9593

96-
:call pymode#troubleshooting#Test()
94+
:call pymode#troubleshooting#test()
9795

98-
And fix any warnings or copy the output and send it to me.
99-
(For example, by creating a `new github issue <https://github.com/klen/python-mode/issues/new>`_ if one does not already exist for the problem).
96+
And fix any warnings or copy the output and send it to me. (For example, by
97+
creating a `new github issue <https://github.com/klen/python-mode/issues/new>`_
98+
if one does not already exist for the problem).
10099

101100

102101
Settings

0 commit comments

Comments
 (0)