INSTALL.md

   1 To install this package you have tree options:\r
   2 \r
   3 1. Use Bakefile\r
   4 \r
   5 ----- TODO: Read the bakefile documentation in order to know more about it and\r
   6                                                 fill this section.\r
   7 \r
   8 \r
   9 2. Use CMake:\r
  10 \r
  11 2.1. In Unix:\r
  12 \r
  13         a) Go to the directory where you extracted the source package;\r
  14 \r
  15         b) Create a directory to build barbara (since CMake likes out-of-source\r
  16      builds), for e.g.:\r
  17 \r
  18                 $mkdir build\r
  19 \r
  20         c) Go to that directory and execute ccmake (or if you have it cmake-gui):\r
  21 \r
  22                 $ccmake -G "Unix Makefiles" ..\\r
  23 \r
  24     Then ccmake will check if the required dependencies are available, and \r
  25                 create the makefile for you to build the package.\r
  26 \r
  27     Note that option G specified that Unix based makefiles are going to be\r
  28                 generated (read cmake documentation if you want to use something else),\r
  29     and that the source directory is one level up (..\), you need to change\r
  30                 that to the relative location of your source folder. If you use cmake-gui\r
  31                 you will choose both the relative source location and the target build\r
  32                 system in the gui.\r
  33 \r
  34         d) If everything went well, build the program using your system make program:\r
  35                 \r
  36                 $make\r
  37 \r
  38         e) Optionally you can run the tests, like this:\r
  39 \r
  40                 $make test\r
  41 \r
  42         f) And install the program automatically if you want, like this:\r
  43 \r
  44                 $make install\r
  45 \r
  46 2.2. In Windows using MSVC:\r
  47 \r
  48         a) Install cmake from it's webpage, then run cmake-gui from either start menu,\r
  49                  or by going to the directory where you install cmake, then to bin/cmake-gui.exe\r
  50 \r
  51         b) Create a directory to build the program, a diferent one than where you\r
  52                  extracted the source files\r
  53 \r
  54   c) Input the directory where you installed the source and the build directory\r
  55                  that you created in the second step, in the cmake-gui and click configure\r
  56 \r
  57         d) Choose the type of makefile to generate, in this case the entry that\r
  58                  contains MSVC\r
  59 \r
  60         e) After the configure fill in where you have the necessary dependencies,\r
  61                  and press configure again (do this step, until you have no more red lines\r
  62                  after pressing configure)\r
  63 \r
  64         f) Press generate, to generate the MSVC projects\r
  65 \r
  66         g) Go to the directory that you created in step b, and click the generated project\r
  67                  file in order to build the program\r
  68 \r
  69                 Note that you can also "build" the pseudo-projects test and install, in order\r
  70                 to test the compiled binaries and install them repectivily.\r
  71 \r
  72 2.3. In Windows using mingw32 and cmd:\r
  73 \r
  74         a) Do the steps a), b) and c) from section 2.2., then do the step d) but instead\r
  75                  of choosing the MSVC, choose MINGW makefiles, continue and execute step e)\r
  76 \r
  77         b) Press generate, to create the mingw makefiles.\r
  78 \r
  79         c) Launch a cmd session, that has the mingw stuff in it's path, go to the build\r
  80                  directory that you created\r
  81 \r
  82                  $cd path\to\build\r
  83 \r
  84         d) Run mingw make to build the files, followed by make test and/or make install\r
  85                  if you want to test and/or install the files automatically.\r
  86 \r
  87 2.4. In Windows using msys:\r
  88 \r
  89         a) Do the steps a), b) and c) from section 2.2, then do the step d) but choosing\r
  90                  msys makefiles, then continue and execute step e)\r
  91 \r
  92         b) Press generate, to create the msys makefiles.\r
  93 \r
  94         c) Launch a msys shell, go to the build directory you created and execute make\r
  95                  to build the files, followed by make test and/or make instal if you want to\r
  96                  test and/or install the files automatically.\r
  97 \r
  98 CMake Note: Since CMake is actually a meta-makefile it can create projects for\r
  99 other platforms/compilers, so you can read CMake documentation if you want to\r
 100 know if cmake supports your compiler (if it isn't in the list), and how to build\r
 101 the project for it.\r
 102 \r
 103 Please read the readme to know which platforms are supported by barbara.\r
 104 \r
 105 3. Use the native build scripts\r
 106 \r
 107   In the root directory there are other build scripts that you may use to\r
 108   compile barbara, if you want to use them read bellow for more information.\r
 109 \r
 110 ----- TODO: After adding another build script, add here the relevant\r
 111                         instructions for it.\r
 112 \r
 113         Note that these files aren't generated regularly but the ones that exist are\r
 114         generated using either cmake or bakefile.\r