Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added installation instructions (fixes #31) #33

Merged
merged 1 commit into from
Oct 19, 2012
Merged

Added installation instructions (fixes #31) #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,27 @@ There is also support for goto and renaming.
Get the latest from `github <http://github.com/davidhalter/jedi>`_.


Installation
============

You can either include Jedi as a submodule in your text editor plugin (like
jedi-vim_ does it by default), or you
can install Jedi systemwide.

The preferred way to install the Jedi library into your system is by using
pip_::

sudo pip install jedi

If you want to install the current development version::

sudo pip install -e git://github.com/davidhalter/jedi.git#egg=jedi

Note: This just installs the Jedi library, not the editor plugins. For
information about how to make it work with your editor, refer to the
corresponding documentation.


Support
=======

Expand Down Expand Up @@ -221,3 +242,8 @@ multiple text objects, in python 3 you could insert ``print``.
settings

Access to the ``settings.py`` module. The settings are described there.



.. _jedi-vim: http://github.com/davidhalter/jedi-vim
.. _pip: http://www.pip-installer.org/