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 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
  40 ~/.bashrc above.
  41 # source /opt/feistymeow.org/feisty_meow/scripts/core/launch_feisty_meow.sh
  42
  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
  45 folder.
  46 See the full list of commands at:
  47 (hmmm: To be completed in 2018)
  48
  49 ==============
  50
  51 How to install the feisty meow script dependencies
  52
  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.
  56
  57 Install using apt-get:
  58 # sudo apt-get install libfile-which-perl libtext-diff-perl
  59
  60 or Install using perl's CPAN:
  61 # sudo cpan install Text::Diff File::Which
  62
  63 ==============
  64
  65 How to install the build dependencies for feisty meow
  66
  67 These dependencies are used for building the applications, tools and tests
  68 in the "nucleus", "octopi", "graphiq" and other C++ collections.
  69
  70 | Ubuntu / Debian:
  71 | # sudo apt-get install build-essential librtmp-dev libcurl4-gnutls-dev libssl-dev
  72
  73 | Centos / Redhat / Fedora:
  74 | # sudo yum install gcc gcc-c++ openssl-devel.x86_64 curl-devel
  75
  76 The "kona" collection depends on Java version 8 or better.
  77
  78 | Ubuntu:
  79 | Set up the java PPA archive as described here:
  80 | https://launchpad.net/~webupd8team/+archive/ubuntu/java
  81
  82 ==============
  83
  84 How to build the feisty meow codebase
  85
  86 Run the following command to build the feisty meow libraries and applications.
  87 # produce_feisty_meow
  88
  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.
  91
  92 ==============
  93
  94 How to clean up the files generated by the build
  95
  96 This command cleans out all the generated files:
  97 # whack_build clean
  98
  99 ==============
 100
 101 What are the feisty meow dependencies?
 102
 103 The feisty meow scripts depend on these scripting languages and tools:
 104   bash
 105   perl (including Text::Diff and File::Which)
 106   python
 107   gnumake
 108
 109 The feisty meow libraries and applications depend on these tools:
 110   Gnu C++
 111   RTMP streams (?still?  not sure.)
 112   Curl
 113   Open SSL
 114
 115 The feisty meow "kona" library depends on these languages:
 116   Java
 117
 118 ==============
 119
 120 Bug reporting
 121
 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.
 125
 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.
 129
 130 ==============
 131
 132 More information is available at the official site: https://feistymeow.org
 133
 134 ==============
 135