Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge pull request #33 from gwrtheyrn/dev

Added installation instructions (fixes #31)
  • Loading branch information...
commit f4b4ef166921d917fc17e6c70a52a361a94d1efb 2 parents 7b8988e + 22a5904
@davidhalter authored
Showing with 26 additions and 0 deletions.
  1. +26 −0 README.rst
View
26 README.rst
@@ -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
=======
@@ -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/
Please sign in to comment.
Something went wrong with that request. Please try again.