Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

initial commit of the installation documentation

  • Loading branch information...
commit 04bd258eaf06545baf7135cf199fcdd677df3798 1 parent 4093cf4
Karl Voit authored
Showing with 27 additions and 0 deletions.
  1. +27 −0 INSTALL.org
27 INSTALL.org
View
@@ -0,0 +1,27 @@
+## Time-stamp: <2012-07-12 11:36:03 vk>
+## This file is best viewed with GNU Emacs Org-mode: http://orgmode.org/
+
+* How to install and set up Memacs
+
+1. *Obtain Memacs*
+ - using one of github download mechanisms OR
+ - use ~pip install memacs~ which handles dependencies
+ - you might as well want to use [[http://pypi.python.org/pypi/virtualenv][virtualenv]] before
+ - make sure that you have *Python v2.7* installed
+
+2. *Choose* the *modules* you want to use
+ - read the files in the ~docs~ folder
+
+3. *Set up one module* after another
+ - please do 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
+ - read the ~Invocation~ section of ~docs/FAQs_and_Best_Practices.org~
+
Please sign in to comment.
Something went wrong with that request. Please try again.