Skip to content

Commit

Permalink
Add some hacking instructions for @teranex.
Browse files Browse the repository at this point in the history
  • Loading branch information
ralphbean committed Nov 11, 2013
1 parent d0d1a32 commit 340a5e2
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions bugwarrior/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,45 @@ download the latest tarball::
$ cd ralphbean-bugwarrior-*
$ python setup.py install

Hacking on It
+++++++++++++

You should install the `virtualenv <https://pypi.python.org/pypi/virtualenv>`_
tool for python. (I use a wrapper for it called `virtualenvwrapper
<https://pypi.python.org/pypi/virtualenvwrapper>`_ which is awesome but not
required.) Virtualenv will help isolate your dependencies from the rest of
your system.

::

$ sudo yum install python-virtualenv git
$ mkdir -p ~/virtualenvs/
$ virtualenv ~/virtualenvs/bugwarrior

You should now have a virtualenv in a ``~/virtualenvs/`` directory.
To use it, you need to "activate" it like this::

$ source ~/virtualenv/bugwarrior/bin/activate
(bugwarrior)$ which python

At any time, you can deactivate it by typing ``deactivate`` at the command
prompt.

Next step -- get the code!

::

(bugwarrior)$ git clone git@github.com:ralphbean/bugwarrior.git
(bugwarrior)$ cd bugwarrior
(bugwarrior)$ python setup.py develop
(bugwarrior)$ which bugwarrior-pull

This will actually run it.. be careful and back up your task directory!

::

(bugwarrior)$ bugwarrior-pull


Contributors
------------
Expand Down

0 comments on commit 340a5e2

Please sign in to comment.