README

   1 This is the README for aesalon, version 0.0.1 (pre-release)
   2
   3 ---- OVERVIEW
   4     In a nutshell, Aesalon is a program to graphically display the dynamically-
   5 allocated memory that another program has allocated. This can be utilized in a
   6 number of different ways.
   7
   8 ---- BUILDING
   9 To build the aesalon executable, you will need the following:
  10 - g++ (only tested with 4.3 and 4.4; but any recent g++ should work. Aesalon is
  11     99% ISO-c++0x compatible; there may be a few things that are not.)
  12 - libpthread, or some other pthread implementation (NOTE: LinuxThreads will
  13     *not* work)
  14 - CMake (at least version 2.6)
  15 - bisonc++ (tested with 2.4.8, but older versions should also work)
  16
  17 For the aesalon GUI, you will additionally need:
  18 - qt devel libraries (tested with Qt 4.5.2, but Qt 4.3 or greater should work)
  19 - qt devel programs (moc4, etc. Note that qmake is *not* required)
  20
  21 Building aesalon is simplicity itself. (Well, maybe.) Depending on your
  22 version of g++, there may be some hand modifications required. Assuming you've
  23 accquired the source from somewhere, simply run these commands:
  24
  25 For both aesalon and aesalon_gui:
  26 user@host[aesalon]$ cmake .
  27 user@host[aesalon]$ make
  28
  29 For only aesalon:
  30 user@host[aesalon]$ cmake .
  31 user@host[aesalon]$ make aesalon
  32
  33 For only aesalon_gui:
  34 user@host[aesalon]$ cmake .
  35 user@host[aesalon]$ make aesalon_gui
  36
  37 If there are any configuration errors, correct them. (You may need to install
  38 additional development libraries.)
  39
  40 The two symlinks in the root of the source directory (aesalon and aesalon_gui)
  41 should now be valid, and pointing to executables. Simply run the symlinks to
  42 run each program. If you so desire, you may copy the executables to a path;
  43 neither requires any data files beyond standard Qt files.
  44
  45 And that is it, ladies and gentlemen -- aesalon is compiled.
  46