diff options
author | Patrick Totzke <patricktotzke@gmail.com> | 2012-03-07 15:49:10 +0000 |
---|---|---|
committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-03-07 15:49:10 +0000 |
commit | 1a00d299c28be974f22761d9095d2448a251feb4 (patch) | |
tree | 95f54c8ef504704467ccc6208967838ab1a48f1a | |
parent | 3eb5a3c2d229fa43f1d99652b99c29dd4400a624 (diff) |
remove INSTALL.md
installation notes are in the user manual, we don't want
to maintain them twice
-rw-r--r-- | INSTALL.md | 81 | ||||
-rw-r--r-- | README.md | 5 |
2 files changed, 3 insertions, 83 deletions
diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index 0abecdec..00000000 --- a/INSTALL.md +++ /dev/null @@ -1,81 +0,0 @@ -INSTALL -======= - -Alot depends on recent versions of notmuch (>=0.10) and urwid (>=1.0). Note that due to restrictions -on argparse and subprocess, you need to run *python v>=2.7*, which only recently made it -into debian testing. - -urwid ------ -make sure you have urwid v >=1.0. It is available on debian (wheezy) -and in *buntu 12.04. To install from git use: - - git clone http://github.com/wardi/urwid - cd urwid - sudo python setup.py install - -It seems you need the python headers for this. On debian/ubuntu: - - aptitude install python2.7-dev - - -notmuch -------- -install notmuch *and* python bindings from git: - - git clone git://notmuchmail.org/git/notmuch - - cd notmuch - ./configure - make - sudo make install - cd bindings/python - python setup.py install --user - - -alot ----- -get alot and install it from git: - - git clone git://github.com/pazz/alot alot - cd alot - python setup.py install --user - make sure `~/.local/bin` is in your path. - - -other dependencies ------------------- - * python bindings to libmagic, greater or equal than v5.04: - http://darwinsys.com/file/ - This is packaged as 'python-magic' in debian/ubuntu. - - * python configobj module, >= v4.6.0 - http://www.voidspace.org.uk/python/configobj.html - http://pypi.python.org/pypi/configobj - This is packaged as 'python-configobj' in debian/ubuntu. - - * python twisted module: - http://twistedmatrix.com/trac/ - This is packaged as 'python-twisted' in debian/ubuntu. - - * a mailcap file (I recommend installing 'mime-support' on debian/ubuntu). - This is used to determine the commands to call when opening attachments - or text-rendering parts that are not plaintext, e.g. text/html. - Make sure you have a inline renderer for text/html set in your mailcap as otherwise - html mails will not display: - - text/html; w3m -dump %s; nametemplate=%s.html; copiousoutput - - -All other configs are optional, but if you want to send mails you need to specify at least one -account section in your config: - - [accounts] - [[your account name]] - realname = Your Name - address = your@address - -See the [user docs][docs] for how to do fancy customization. - - -[docs]: http://alot.rtfd.org @@ -1,8 +1,8 @@ Alot is an experimental terminal MUA based on [notmuch mail][notmuch]. It is written in python using the [urwid][urwid] toolkit. -See `INSTALL.md` for instructions on how to set it up and have a look -at the [user manual][docs] for advanced usage, customization and hacking guides. +Have a look at the [user manual][docs] for installation notes, advanced usage, +customization and hacking guides. Do comment on the code or file issues! I'm curious what you think of it. You can talk to me in `#notmuch@Freenode`. @@ -27,6 +27,7 @@ Current features include: Soonish to be addressed non-features: ------------------------------------- See [here][features], most notably: + * encryption/decryption for messages (see branch `gnupg`) * live search results (branch `live`) * search for message (branch `messagesmode`) |