INSTALL.md

   1 # INSTALL.md #
   2
   3 These are instruction on the requirements and how to install this software.
   4
   5 ## Requirements ##
   6
   7 In order to install this software, you will need the following programs and
   8 libraries installed on your computer.
   9 Note that for the dependencies referred to as optional, their availability
  10 is optional, and only needed if you need the functionality given by those
  11 depdencies.
  12
  13   * Dependency X version > 3.X;
  14   * Dependency Y version >= 4.X.Z; (optional, if you required XXX (root beer))
  15   * tup (http://gittup.org/tup/);
  16   * tup-config (https://github.com/msteinert/tup-config);
  17   * pkg-config; (optional, if you are on Unix and want to detect the presence of
  18     some programs)
  19
  20
  21 ## Configuration ##
  22
  23 In order to configure this program, check that all requirements are present, and
  24 any optional requirements you want, then in a console type:
  25
  26   * tup-mconf (if you have ncurses (typically under an Unix or MacOSX)); OR
  27   * tup-nconf (if you have ncurses, and prefer this over tup-mconf); OR
  28   * tup-gconf (if you have gtk+ (typically under Gnome or Windows (with Gtk+))); OR
  29   * tup-qconf (if you have Qt (typically under KDE or Windows (with Qt)));
  30
  31 Then, follow the configuration screens and the instructions given in the sctipt
  32 in order to configure the software the way you like.
  33
  34 ## Building ##
  35
  36 After configuring the software, you can build it in the same shell using:
  37
  38   * tup upd (you may also add -jN here were N is the number of update jobs
  39     you want, normally somewhere between 1 to the number of processors your
  40     machine has, but you must use this option carefully or you might fry your
  41     machine);
  42
  43 You will need to run this command in a shell that has the visual studio
  44 variables if you are on windows and wish to compile using visual studio C++
  45 compiler.
  46
  47 ## Installing ##
  48
  49