updated to use vars for the paths and added comments.
[feisty_meow.git] / building.txt
1
2 ====
3
4 Quick Start for the Feisty Meow Codebase:
5
6   Getting the Codebase:
7
8     Retrieve a clone of the feisty meow codebase.
9
10     git clone git://feistymeow.org:feisty_meow
11
12     The rest of these notes assume that you stored the codebase in:
13       ~/feisty_meow (aka $HOME/feisty_meow).
14
15   Building the Codebase:
16
17     Run the following command to build the Feisty Meow libraries and
18     applications.
19     Note that you may need to install some dependencies first (see below
20     for installation instructions).
21
22     bash ~/feisty_meow/scripts/generator/produce_feisty_meow.sh
23
24     All the applications can be found in $BINDIR
25     after the build is complete.
26
27   Cleaning the Codebase:
28
29     Once you've got a bootstrapped build, you can clean out all the generated
30     files with this command:
31
32     bash ~/feisty_meow/scripts/generator/whack_build.sh clean
33
34   Loading the Feisty Meow scripting environment:
35
36     Set up the feisty_meow scripts the first time; this is only needed once,
37     unless you want to regenerate the scripts from the latest version.
38
39     bash ~/feisty_meow/scripts/core/reconfigure_feisty_meow.sh
40
41     Load the script environment into the current shell.
42
43     source ~/feisty_meow/scripts/core/launch_feisty_meow.sh
44
45     Loading the feisty meow script environment with the above command allows
46     you to build specific projects in feisty meow by changing into the
47     project's directory and running 'make'.
48     Some example start-up files for loading feisty meow can be found in
49     ~/feisty_meow/feisty_inits.
50
51 ====
52
53 Feisty Meow Dependencies:
54
55 The feisty meow scripts depend on these scripting languages and tools:
56   bash
57   perl
58     Text::Diff
59     File::Which
60   python
61   gnumake
62
63 The feisty meow libraries and applications depend on these tools (see below
64 for installation steps):
65   Gnu C++
66   RTMP streams
67   Curl
68   Open SSL
69
70 ====
71
72 How to install the most frequently needed compiler and library dependencies:
73
74   Ubuntu / Debian:
75     sudo apt-get install build-essential librtmp-dev libcurl4-gnutls-dev libssl-dev
76
77   Centos / Redhat / Fedora:
78     sudo yum install gcc gcc-c++ openssl-devel.x86_64 curl-devel
79
80 ====
81
82 How to install the Feisty Meow script dependencies:
83
84   cpan install Text::Diff File::Which
85
86   These perl modules are required for a few of the feisty meow scripts to
87   work properly.  The differ utility and the feisty meow customization system
88   will be affected without these modules installed.
89
90 ====
91
92 More information is available at the official site http://feistymeow.org
93
94 ====
95