Skip to content

Commit

Permalink
README: document installation and package requirements
Browse files Browse the repository at this point in the history
followup of #151
  • Loading branch information
flokli committed Jul 14, 2017
1 parent fbcda8b commit 50148e4
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,31 @@ Features
Installation
------------

And I'd like to suggest to install afew as your unprivileged user.
If you do, make sure ``~/.local/bin`` is in your path.
Make sure you have already installed your distributions `notmuch`
package, and the notmuch python bindings, which might come in separate
`python-notmuch` and `python3-notmuch` packages.

It is recommended to install `afew` itself inside a virtualenv as an unprivileged
user, either via checking out the source code and installing via setup.py, or
via pip.

.. code:: bash
$ python setup.py install --prefix=~/.local
$ mkdir -p ~/.config/afew ~/.local/share/afew/categories
# create and activate virtualenv
$ python -m venv --system-site-packages .venv
$ source .venv/bin/activate
# install via pip from PyPI:
$ pip install afew
# or install from source:
$ python setup.py install
You might want to symlink `.venv/bin/afew` somewhere inside your path
(~/bin/ in this case):

.. code:: bash
$ ln -snr .venv/bin/afew ~/.bin/afew
Expand Down

0 comments on commit 50148e4

Please sign in to comment.