diff --git a/README.rst b/README.rst index f0232be..2280f54 100644 --- a/README.rst +++ b/README.rst @@ -42,6 +42,9 @@ Latest release (v0.1) EarwigBot is available from the `Python Package Index`_, so you can install the latest release with ``pip install earwigbot`` (`get pip`_). +If you get an error while pip is installing dependencies, you may be missing +some header files. For example, on Ubuntu, see `this StackOverflow post`_. + You can also install it from source [1]_ directly:: curl -Lo earwigbot.tgz https://github.com/earwig/earwigbot/tarball/v0.1 @@ -55,10 +58,10 @@ Development version ~~~~~~~~~~~~~~~~~~~ You can install the development version of the bot from ``git`` by using -setuptools/distribute's ``develop`` command [1]_, probably on the ``develop`` -branch which contains (usually) working code. ``master`` contains the latest -release. EarwigBot uses `git flow`_, so you're free to -browse by tags or by new features (``feature/*`` branches):: +setuptools's ``develop`` command [1]_, probably on the ``develop`` branch which +contains (usually) working code. ``master`` contains the latest release. +EarwigBot uses `git flow`_, so you're free to browse by tags or by new features +(``feature/*`` branches):: git clone git://github.com/earwig/earwigbot.git earwigbot cd earwigbot @@ -190,6 +193,7 @@ Footnotes .. _earwigbot-plugins: https://github.com/earwig/earwigbot-plugins .. _Python Package Index: https://pypi.python.org/pypi/earwigbot .. _get pip: http://pypi.python.org/pypi/pip +.. _this StackOverflow post: http://stackoverflow.com/questions/6504810/how-to-install-lxml-on-ubuntu/6504860#6504860 .. _git flow: http://nvie.com/posts/a-successful-git-branching-model/ .. _explanation of YAML: http://en.wikipedia.org/wiki/YAML .. _earwigbot.bot.Bot: https://github.com/earwig/earwigbot/blob/develop/earwigbot/bot.py diff --git a/docs/installation.rst b/docs/installation.rst index 12fc907..a594623 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -19,6 +19,9 @@ Latest release (v0.1) EarwigBot is available from the `Python Package Index`_, so you can install the latest release with :command:`pip install earwigbot` (`get pip`_). +If you get an error while pip is installing dependencies, you may be missing +some header files. For example, on Ubuntu, see `this StackOverflow post`_. + You can also install it from source [1]_ directly:: curl -Lo earwigbot.tgz https://github.com/earwig/earwigbot/tarball/v0.1 @@ -32,10 +35,10 @@ Development version ------------------- You can install the development version of the bot from :command:`git` by using -setuptools/`distribute`_'s :command:`develop` command [1]_, probably on the -``develop`` branch which contains (usually) working code. ``master`` contains -the latest release. EarwigBot uses `git flow`_, so you're free to browse by -tags or by new features (``feature/*`` branches):: +setuptools's :command:`develop` command [1]_, probably on the ``develop`` +branch which contains (usually) working code. ``master`` contains the latest +release. EarwigBot uses `git flow`_, so you're free to browse by tags or by new +features (``feature/*`` branches):: git clone git://github.com/earwig/earwigbot.git earwigbot cd earwigbot @@ -51,5 +54,5 @@ tags or by new features (``feature/*`` branches):: .. _earwigbot-plugins: https://github.com/earwig/earwigbot-plugins .. _Python Package Index: http://pypi.python.org .. _get pip: http://pypi.python.org/pypi/pip -.. _distribute: http://pypi.python.org/pypi/distribute +.. _this StackOverflow post: http://stackoverflow.com/questions/6504810/how-to-install-lxml-on-ubuntu/6504860#6504860 .. _git flow: http://nvie.com/posts/a-successful-git-branching-model/