4 Quick Start Guide for the Feisty Meow Codebase
6 Commands that can be typed in a console or terminal are are prefixed with "#".
7 Information that varies by platform is prefixed with a '|' character.
9 This documentation assumes that the code is stored in the default location:
10 /opt/feistymeow.org/feistymeow
11 If you have stored it elsewhere, then please adapt the commands accordingly.
15 How to get the feisty meow codebase
17 | On Microsoft Windows, install the Cygwin tools as documented here:
18 | /opt/feistymeow.org/feisty_meow/documentation/cygwin_install_list.txt (local file) or
19 | https://feistymeow.org/feisty_meow/documentation/cygwin_install_list.txt (web)
21 Retrieve a clone of the feisty meow codebase:
22 # git clone git://feistymeow.org/feisty_meow
26 How to load the feisty meow script environment
28 Set up the feisty_meow scripts; this is only needed once, when you first get
29 the codebase. It will also regenerate the scripts using the latest installed
31 # bash /opt/feistymeow.org/feisty_meow/scripts/core/reconfigure_feisty_meow.sh
33 Connect the feisty meow scripts to your login script (in ~/.bashrc).
34 Note that this actually modifies ~/.bashrc. This step is only needed once.
35 # bash /opt/feistymeow.org/feisty_meow/scripts/core/connect_feisty_meow.sh
37 Load the script environment into the current shell. This can be done for
38 any new shell. This is idempotent, so it does no harm to run it again.
39 Note that you should not need this step if you connected feisty meow to
41 # source /opt/feistymeow.org/feisty_meow/scripts/core/launch_feisty_meow.sh
43 When the feisty meow script environment loaded, many new aliases and
44 functions are available for use. These come from the $FEISTY_MEOW_SCRIPTS
46 See the full list of commands at:
47 (hmmm: To be completed in 2018)
51 How to install the feisty meow script dependencies
53 A couple of perl modules are required by some of the scripts (including the
54 differ utility and the feisty meow customization system). They can be
55 installed with either apt-get or CPAN.
57 Install using apt-get:
58 # sudo apt-get install libfile-which-perl libtext-diff-perl
60 or Install using perl's CPAN:
61 # sudo cpan install Text::Diff File::Which
65 How to install the build dependencies for feisty meow
67 These dependencies are used for building the applications, tools and tests
68 in the "nucleus", "octopi", "graphiq" and other C++ collections.
71 | # sudo apt-get install build-essential librtmp-dev libcurl4-gnutls-dev libssl-dev
73 | Centos / Redhat / Fedora:
74 | # sudo yum install gcc gcc-c++ openssl-devel.x86_64 curl-devel
76 The "kona" collection depends on Java version 8 or better.
79 | Set up the java PPA archive as described here:
80 | https://launchpad.net/~webupd8team/+archive/ubuntu/java
84 How to build the feisty meow codebase
86 Run the following command to build the feisty meow libraries and applications.
89 After the build is complete, the feisty meow applications can be found in
90 the folder pointed at by the $FEISTY_MEOW_BINARIES environment variable.
94 How to clean up the files generated by the build
96 This command cleans out all the generated files:
101 What are the feisty meow dependencies?
103 The feisty meow scripts depend on these scripting languages and tools:
105 perl (including Text::Diff and File::Which)
109 The feisty meow libraries and applications depend on these tools:
111 RTMP streams (?still? not sure.)
115 The feisty meow "kona" library depends on these languages:
122 Report bugs at the feisty meow trac site:
123 https://trac.feistymeow.org/projects/feistymeow/report
124 Email fred@gruntose.com for authorization to write up new bug reports.
126 There is also a github mirror of feisty meow at:
127 https://github.com/fredhamster/feisty_meow
128 The github repository will accept bug reports without an authorization process.
132 More information is available at the official site: https://feistymeow.org