doc/feisty_meow_quick_start.txt

   1
   2 Feisty Meow Concerns Ltd. is a small software shop that concentrates on building high quality,
   3 portable, open source projects in a variety of languages (primarily bash, perl, python, C++,
   4 and Java).  Here are some highlights of our main products:
   5
   6   Bookmark Processing Tools - can take a mozilla bookmark file or arbitrary
   7      web page and extract all the links out of it, building a csv database of
   8      web links.  Using that database, a variety of output formats are
   9      provided, including one that outputs a mozilla bookmark file again.
  10      The most useful feature is probably the marks checker that operates on
  11      our csv format and that locates all unreachable links in the file and
  12      separates them out.
  13
  14   CROMP protocol - supports transmission of objects across the network and
  15      provides a platform independent method for RPC and other types of
  16      communication.
  17
  18   Octopus design pattern - the underpinning of the CROMP protocol.  An octopus
  19      has an arbitrary number of tentacles (no, not just eight) which are each
  20      responsible for consuming a different type of object (or datum).
  21
  22   Fast Templates and Portable Abstractions - the class libraries of Feisty Meow
  23      provide numerous different data structures and programming language
  24      abstractions (like threads and state machines).  There are also some
  25      fairly ancient templates (in use since late 80s) which in many cases
  26      perform faster than their STL analogues.
  27
  28   CLAM System - Feisty Meow is the home site of the CLAM makefile system.  The
  29      CLAM system is a flexible and extensible method for building C++ and
  30      C# files using makefiles.
  31
  32 Prerequisites:
  33
  34   Software required to compile under Linux:
  35     curl-devel
  36     openmotif-devel
  37     openssl-devel
  38     wxGTK-devel
  39
  40   Software required to compiler under MS-windows:
  41     The free Microsoft compiler should build Feisty Meow but it is untested.
  42     The full version of MS Visual Studio 2010 (version 10) is supported.
  43     Gnu C++ should compile Feisty Meow but it is also untested recently.
  44
  45 Quick Start:
  46
  47   Run the following commands to bootstrap the Feisty Meow libraries, once you
  48   have downloaded the archive or retrieved them via CVS (assuming that you
  49   have stored the files in ~/feisty_meow):
  50
  51     bash ~/feisty_meow2/scripts/generator/bootstrap_build.sh
  52
  53   This should create the 'makedep' dependency checking tool and the version
  54   tagging tool and then go through the rest of the build.
  55
  56   Once you've got a bootstrapped build, you can clean out all the files with:
  57
  58     bash ~/feisty_meow2/scripts/generator/whack_build.sh clean
  59
  60   And if you want to load the build environment for doing makes inside the
  61   feisty_meow hierarchies, you can either run a sub-shell with the environment:
  62
  63     bash ~/feisty_meow2/scripts/generator/build_variables.sh
  64
  65   or you can load them into the current shell:
  66
  67     bv=~/feisty_meow2/scripts/generator/build_variables.sh; source $bv $bv
  68
  69   (The double reference is required since a sourced script does not get any of
  70   the command-line parameters from the parent script.)
  71
  72   More information is available at the official site http://feistymeow.org
  73
  74