Skip to content

Latest commit

 

History

History
68 lines (50 loc) · 2.79 KB

INSTALL.org

File metadata and controls

68 lines (50 loc) · 2.79 KB
Raw

## Time-stamp: <2014-12-21 13:02:43 vk> ## This file is best viewed with GNU Emacs Org-mode: http://orgmode.org/

How to install and set up Memacs

Obtain Memacs

  • using one of github download mechanisms OR
  • use pip install memacs which handles dependencies
  • make sure that you have Python v2.7 installed

Installing Using virtualenv and PIP (recommended!)

I installed Memacs using PIP with the following commands:

First, I created a virtualenv environment using a local installation of Python 3 (you can use the Python installation of your site of course):

~/.local/lib/python3.5/site-packages/virtualenv.py -p /home/karl/bin/Python-3.5.3/bin/python memacs

I entered the folder cd memacs and activated the environment . bin/activate. After that, I installed Memacs using PIP with pip install memacs

Within this activated virtualenv, PYTHONPATH is set correctly and I am able to start any module directly like

~/src/memacs/bin/memacs_rss.py -u ...

Summary:

~/.local/lib/python3.5/site-packages/virtualenv.py -p /home/karl/bin/Python-3.5.3/bin/python memacs
cd memacs
. bin/activate
pip install memacs
~/src/memacs/bin/memacs_rss.py --help

You don’t have to activate the virtualenv for further calls. Just start the modules located in the bin-folder of Memacs.

Updating PIP-Memacs

cd memacs
. bin/activate
pip install memacs --upgrade

Installing on OS X with homebrew without virtualenv

If you decide not to use virtualenv (not recommended), you are probably interested in a comment of a user who described the manualprocess here .

Choose the modules you want to use

  • read the files in the docs folder
  • start the modules from the bin folder of Memacs

Set up one module after another

  • please make sure you read docs/FAQs_and_Best_Practices.org
    • it contains many tips and tricks on how to meet your requirements and on how to choose a reasonable setup
  • start the module of your choice with the argument --help
    • modules are located in the bin sub-folder
    • for example: /memacs/bin % ./memacs_svn.py --help
    • each module has some general arguments and module-specific arguments
  • you probably want to develop and test a module invocation in the command line and when it works:
  • set up a periodical invocation