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