4 Quick Start Guide for the Feisty Meow Codebase
6 Commands that can be typed in a console or terminal are prefixed with "$".
7 (Do not include the dollar sign when copying and pasting commands.)
8 Information that varies by platform is prefixed with a '|' character.
10 This documentation assumes that the code is stored in the default location:
11 /opt/feistymeow.org/feistymeow
12 If you have stored it elsewhere, then please adapt the commands accordingly.
16 How to get the feisty meow codebase
18 These steps assume that you have the "git" tool available.
20 | On Microsoft Windows, install the Cygwin tools as documented here:
21 | /opt/feistymeow.org/feisty_meow/documentation/cygwin_install_list.txt (local file) or
22 | https://feistymeow.org/feisty_meow/documentation/cygwin_install_list.txt (web)
24 Retrieve a clone of the feisty meow codebase:
25 $ git clone git://feistymeow.org/feisty_meow
29 How to load the feisty meow script environment
31 Prepare your host by installing the packages needed to bootstrap feisty meow.
32 If this fails, then you may need the manual installation steps at the end of
34 $ bash /opt/feistymeow.org/feisty_meow/scripts/core/prep_feisty_host.sh
36 Set up the feisty_meow scripts; this is only needed once, when you first get
38 $ bash /opt/feistymeow.org/feisty_meow/scripts/core/reconfigure_feisty_meow.sh
40 Connect the feisty meow scripts to your login script (in ~/.bashrc).
41 Note that this actually modifies ~/.bashrc. This step is only needed once.
42 $ bash /opt/feistymeow.org/feisty_meow/scripts/core/connect_feisty_meow.sh
44 | For the root user, you can pass a flag '--root' to the connect_feisty_meow
45 | script. This will add an alias for 'feistyme' which loads the feisty meow
46 | scripts on demand (instead of automatically upon login).
48 Load the script environment into the current shell. This can be done for
49 any new shell. This is idempotent, so it does no harm to run it again.
50 Note that you should not need this step if you connected feisty meow to
52 $ source /opt/feistymeow.org/feisty_meow/scripts/core/launch_feisty_meow.sh
54 When the feisty meow script environment loaded, many new aliases and
55 functions are available for use. These come from the $FEISTY_MEOW_SCRIPTS
57 There is a list of feisty meow script commands available at:
58 https://feistymeow.org/feisty_meow/documentation/feisty_meow_command_reference.txt
62 How to update the feisty meow codebase to the latest online version
64 This assumes that a somewhat current version of feisty meow is already
65 installed and the scripts are loaded (see above section for how to load).
67 The command below retrieves the latest version of feisty meow codebase
68 from the online repository and regenerates the scripts.
70 $ rpuffer $FEISTY_MEOW_APEX ; regenerate
74 How to build the feisty meow codebase
76 Run the following command to build the feisty meow libraries and applications.
79 After the build is complete, the feisty meow applications can be found in
80 the folder pointed at by the $FEISTY_MEOW_BINARIES environment variable.
84 How to clean up the files generated by the build
86 This command cleans out all the generated files:
91 What are the feisty meow dependencies?
93 The feisty meow scripts depend on these scripting languages and tools:
95 perl (including Text::Diff and File::Which)
99 The feisty meow libraries and applications depend on these tools:
101 RTMP streams (?still? not sure.)
105 The feisty meow "kona" library depends on these languages:
112 Report bugs at the feisty meow trac site:
113 https://trac.feistymeow.org/projects/feistymeow/report
114 Email fred@gruntose.com for authorization to write up new bug reports.
116 There is also a github mirror of feisty meow at:
117 https://github.com/fredhamster/feisty_meow
118 The github repository will accept bug reports without an authorization process.
122 More information is available at the official site: https://feistymeow.org
126 Manual Installation Steps:
128 How to install the feisty meow script dependencies...
130 A couple of perl modules are required by some of the scripts (including the
131 differ utility and the feisty meow customization system). They can be
132 installed with either apt or CPAN.
134 Install using apt (on Ubuntu or Debian-based OS):
135 $ sudo apt install libfile-which-perl libtext-diff-perl
137 Install using yum (on Centos or similar distros):
138 $ yum install perl-File-Which perl-Text-Diff
140 or Install using perl's CPAN:
141 $ sudo cpan install Text::Diff File::Which
143 or on Cygwin (MS-Windows), install with apt-cyg:
144 $ apt-cyg install perl-File-Which perl-Text-Diff
146 How to install the build dependencies for feisty meow...
148 These dependencies are used for building the applications, tools and tests
149 in the "nucleus", "octopi", "graphiq" and other C++ collections.
152 | $ sudo apt install build-essential librtmp-dev libcurl4-gnutls-dev libssl-dev
154 | Centos / Redhat / Fedora:
155 | $ sudo yum install gcc gcc-c++ openssl-devel.x86_64 curl-devel
157 The "kona" collection depends on Java version 8 or better.
160 | Set up the java PPA archive as described here:
161 | https://launchpad.net/~webupd8team/+archive/ubuntu/java