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 Information that varies by platform is prefixed with a '|' character.
   8
   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.
  12
  13 ==============
  14
  15 How to get the feisty meow codebase
  16
  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)
  20
  21 Retrieve a clone of the feisty meow codebase:
  22 # git clone git://feistymeow.org/feisty_meow
  23
  24 ==============
  25
  26 How to load the feisty meow script environment
  27
  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
  30 version.
  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 See the full list of commands at:
  51 (hmmm: To be completed in 2018)
  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 install the build dependencies for feisty meow
  73
  74 These dependencies are used for building the applications, tools and tests
  75 in the "nucleus", "octopi", "graphiq" and other C++ collections.
  76
  77 | Ubuntu / Debian:
  78 | # sudo apt-get install build-essential librtmp-dev libcurl4-gnutls-dev libssl-dev
  79
  80 | Centos / Redhat / Fedora:
  81 | # sudo yum install gcc gcc-c++ openssl-devel.x86_64 curl-devel
  82
  83 The "kona" collection depends on Java version 8 or better.
  84
  85 | Ubuntu:
  86 | Set up the java PPA archive as described here:
  87 | https://launchpad.net/~webupd8team/+archive/ubuntu/java
  88
  89 ==============
  90
  91 How to build the feisty meow codebase
  92
  93 Run the following command to build the feisty meow libraries and applications.
  94 # produce_feisty_meow
  95
  96 After the build is complete, the feisty meow applications can be found in
  97 the folder pointed at by the $FEISTY_MEOW_BINARIES environment variable.
  98
  99 ==============
 100
 101 How to clean up the files generated by the build
 102
 103 This command cleans out all the generated files:
 104 # whack_build clean
 105
 106 ==============
 107
 108 What are the feisty meow dependencies?
 109
 110 The feisty meow scripts depend on these scripting languages and tools:
 111   bash
 112   perl (including Text::Diff and File::Which)
 113   python
 114   gnumake
 115
 116 The feisty meow libraries and applications depend on these tools:
 117   Gnu C++
 118   RTMP streams (?still?  not sure.)
 119   Curl
 120   Open SSL
 121
 122 The feisty meow "kona" library depends on these languages:
 123   Java
 124
 125 ==============
 126
 127 Bug reporting
 128
 129 Report bugs at the feisty meow trac site:
 130 https://trac.feistymeow.org/projects/feistymeow/report
 131 Email fred@gruntose.com for authorization to write up new bug reports.
 132
 133 There is also a github mirror of feisty meow at:
 134 https://github.com/fredhamster/feisty_meow
 135 The github repository will accept bug reports without an authorization process.
 136
 137 ==============
 138
 139 More information is available at the official site: https://feistymeow.org
 140
 141 ==============
 142