readme.txt

   1
   2 ==============
   3 Quick Start Guide for the Feisty Meow Codebase
   4
   5 Commands that you should enter into your terminal are prefixed with "=>" and
   6 conditional portions are prefixed with a '|' character.
   7
   8 ==============
   9 How to get the feisty meow codebase
  10
  11 | On Microsoft Windows, install the Cygwin tools as documented here:
  12 | ~/feisty_meow/documentation/cygwin_install_list.txt (local file) or
  13 | https://feistymeow.org/feisty_meow/documentation/cygwin_install_list.txt (web)
  14
  15 Retrieve a clone of the feisty meow code:
  16 # git clone git://feistymeow.org/feisty_meow
  17
  18 The remainder of these notes assume that the code is stored in
  19 ~/feisty_meow (aka $HOME/feisty_meow).
  20
  21 ==============
  22 How to load the feisty meow script environment
  23
  24 Set up the feisty_meow scripts; this is only needed once, when you first get
  25 the codebase.  It can also regenerate the scripts using the latest version.
  26 # bash ~/feisty_meow/scripts/core/reconfigure_feisty_meow.sh
  27
  28 Load the script environment into the current shell.
  29 # source ~/feisty_meow/scripts/core/launch_feisty_meow.sh
  30
  31 With the feisty meow script environment loaded, several aliases are now
  32 available for building the codebase and they are used in the sections below.
  33
  34 Closing the current shell will lose the feisty meow environment.  Loading the
  35 environment can be made automatic by adding the 'source' line above to the
  36 shell's startup file.  Example startup files are available in:
  37 ~/feisty_meow/feisty_inits
  38
  39 ==============
  40 How to install the feisty meow script dependencies
  41
  42 A couple of perl modules are required by some of the scripts (including the
  43 differ utility and the feisty meow customization system).  They can be
  44 installed with either apt-get or CPAN.
  45
  46 Install using apt-get:
  47 # sudo apt-get install libfile-which-perl libtext-diff-perl
  48
  49 or Install using perl's CPAN:
  50 # sudo cpan install Text::Diff File::Which
  51
  52 ==============
  53 How to install the build dependencies for feisty meow
  54
  55 | Ubuntu / Debian:
  56 | # sudo apt-get install build-essential librtmp-dev libcurl4-gnutls-dev libssl-dev
  57
  58 | Centos / Redhat / Fedora:
  59 | # sudo yum install gcc gcc-c++ openssl-devel.x86_64 curl-devel
  60
  61 | Microsoft Windows:
  62 | Download and install the Cygwin environment first from cygwin.com, which is
  63 | documented in ~/feisty_meow/documentation/cygwin_install_list.txt
  64
  65 ==============
  66 How to build the feisty meow codebase
  67
  68 Run the following command to build the feisty meow libraries and applications.
  69 # bash ~/feisty_meow/scripts/generator/produce_feisty_meow.sh
  70
  71 After the build is complete, the feisty meow applications can be found in
  72 $FEISTY_MEOW_BINARIES (environment variable).
  73 # ls $FEISTY_MEOW_BINARIES
  74
  75 ==============
  76 How to clean up the files generated by the build
  77
  78 This command cleans out all the generated files:
  79 # bash ~/feisty_meow/scripts/generator/whack_build.sh clean
  80
  81 ==============
  82 What are the feisty meow dependencies?
  83
  84 The feisty meow scripts depend on these scripting languages and tools:
  85   bash
  86   perl (including Text::Diff and File::Which)
  87   python
  88   gnumake
  89
  90 The feisty meow libraries and applications depend on these tools:
  91   Gnu C++
  92   RTMP streams (?still?  not sure.)
  93   Curl
  94   Open SSL
  95
  96 ==============
  97 More information is available at the official site http://feistymeow.org
  98