readme.txt

   1
   2 ==============
   3
   4 Quick Start Guide for the Feisty Meow Codebase
   5
   6 Commands that can be typed in a console or terminal are 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.
   9
  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.
  13
  14 ==============
  15
  16 How to get the feisty meow codebase
  17
  18 | On Microsoft Windows, install the Cygwin tools as documented here:
  19 | /opt/feistymeow.org/feisty_meow/documentation/cygwin_install_list.txt (local file) or
  20 | https://feistymeow.org/feisty_meow/documentation/cygwin_install_list.txt (web)
  21
  22 Retrieve a clone of the feisty meow codebase:
  23 $ git clone git://feistymeow.org/feisty_meow
  24
  25 ==============
  26
  27 How to load the feisty meow script environment
  28
  29 Set up the feisty_meow scripts; this is only needed once, when you first get
  30 the codebase.
  31 $ bash /opt/feistymeow.org/feisty_meow/scripts/core/reconfigure_feisty_meow.sh
  32
  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
  36
  37 | For the root user, you can pass a flag '--root' to the connect_feisty_meow
  38 | script.  This will add an alias for 'feistyme' which loads the feisty meow
  39 | scripts on demand (instead of automatically upon login).
  40
  41 Load the script environment into the current shell.  This can be done for
  42 any new shell.  This is idempotent, so it does no harm to run it again.
  43 Note that you should not need this step if you connected feisty meow to
  44 ~/.bashrc above.
  45 $ source /opt/feistymeow.org/feisty_meow/scripts/core/launch_feisty_meow.sh
  46
  47 When the feisty meow script environment loaded, many new aliases and
  48 functions are available for use.  These come from the $FEISTY_MEOW_SCRIPTS
  49 folder.
  50 There is a list of feisty meow script commands available at:
  51 https://feistymeow.org/feisty_meow/documentation/feisty_meow_command_reference.txt
  52
  53 ==============
  54
  55 How to install the feisty meow script dependencies
  56
  57 A couple of perl modules are required by some of the scripts (including the
  58 differ utility and the feisty meow customization system).  They can be
  59 installed with either apt-get or CPAN.
  60
  61 Install using apt-get (on Ubuntu or Debian-based OS):
  62 $ sudo apt-get install libfile-which-perl libtext-diff-perl
  63
  64 or Install using perl's CPAN:
  65 $ sudo cpan install Text::Diff File::Which
  66
  67 or on Cygwin (MS-Windows), install with apt-cyg:
  68 $ apt-cyg install perl-File-Which perl-Text-Diff
  69
  70 ==============
  71
  72 How to update the feisty meow codebase to the latest online version
  73
  74 This assumes that a somewhat current version of feisty meow is already
  75 installed and the scripts are loaded (see above section for how to load).
  76
  77 The command below retrieves the latest version of feisty meow codebase
  78 from the online repository and regenerates the scripts.
  79
  80 $ rpuffer $FEISTY_MEOW_APEX ; regenerate
  81
  82 ==============
  83
  84 How to install the build dependencies for feisty meow
  85
  86 These dependencies are used for building the applications, tools and tests
  87 in the "nucleus", "octopi", "graphiq" and other C++ collections.
  88
  89 | Ubuntu / Debian:
  90 | $ sudo apt-get install build-essential librtmp-dev libcurl4-gnutls-dev libssl-dev
  91
  92 | Centos / Redhat / Fedora:
  93 | $ sudo yum install gcc gcc-c++ openssl-devel.x86_64 curl-devel
  94
  95 The "kona" collection depends on Java version 8 or better.
  96
  97 | Ubuntu:
  98 | Set up the java PPA archive as described here:
  99 | https://launchpad.net/~webupd8team/+archive/ubuntu/java
 100
 101 ==============
 102
 103 How to build the feisty meow codebase
 104
 105 Run the following command to build the feisty meow libraries and applications.
 106 $ produce_feisty_meow
 107
 108 After the build is complete, the feisty meow applications can be found in
 109 the folder pointed at by the $FEISTY_MEOW_BINARIES environment variable.
 110
 111 ==============
 112
 113 How to clean up the files generated by the build
 114
 115 This command cleans out all the generated files:
 116 $ whack_build clean
 117
 118 ==============
 119
 120 What are the feisty meow dependencies?
 121
 122 The feisty meow scripts depend on these scripting languages and tools:
 123   bash
 124   perl (including Text::Diff and File::Which)
 125   python
 126   gnumake
 127
 128 The feisty meow libraries and applications depend on these tools:
 129   Gnu C++
 130   RTMP streams (?still?  not sure.)
 131   Curl
 132   Open SSL
 133
 134 The feisty meow "kona" library depends on these languages:
 135   Java
 136
 137 ==============
 138
 139 Bug reporting
 140
 141 Report bugs at the feisty meow trac site:
 142 https://trac.feistymeow.org/projects/feistymeow/report
 143 Email fred@gruntose.com for authorization to write up new bug reports.
 144
 145 There is also a github mirror of feisty meow at:
 146 https://github.com/fredhamster/feisty_meow
 147 The github repository will accept bug reports without an authorization process.
 148
 149 ==============
 150
 151 More information is available at the official site: https://feistymeow.org
 152
 153 ==============
 154