X-Git-Url: https://feistymeow.org/gitweb/?a=blobdiff_plain;f=readme.txt;h=bfb4793a38a4cae805657fbf8c2a04492d4532c0;hb=834c544cb3bb3e82dbf39ba3f2855fa1a59b647e;hp=d1e867eb7d7f44f3cff5611413dfbd12d73cb733;hpb=2952ccf47b80174880141a7ecfa122089f349b8d;p=feisty_meow.git

diff --git a/readme.txt b/readme.txt
index d1e867eb..bfb4793a 100644
--- a/readme.txt
+++ b/readme.txt
@@ -1,38 +1,98 @@
 
-This is the "feisty meow concerns" codebase top folder.
+==============
+Quick Start Guide for the Feisty Meow Codebase
 
-Feisty Meow Concerns codebase comprises some but probably not all of several projects that
-have come before.  These include the Twain.COM library scripts, the Yeti / YetiCode library
-scripts, the HOOPLE 1 and HOOPLE 2 C++ Codebases, the Fred Huffhines opensource LSL scripts,
-the CLAM build system, and a variety of other efforts.
+Commands that you should enter into your terminal are prefixed with "=>" and
+conditional portions are prefixed with a '|' character.
 
-Directories and files of interest here...
+==============
+How to get the feisty meow codebase
 
-core/
-    The hierarchies of compiled code for the basic modules of the Feisty Meow hoople2 codebase.
+| On Microsoft Windows, install the Cygwin tools as documented here:
+| ~/feisty_meow/documentation/cygwin_install_list.txt (local file) or
+| https://feistymeow.org/feisty_meow/documentation/cygwin_install_list.txt (web)
 
-database/
-    Some files considered critical to the operations of Feisty Meow Concerns Ltd.  This includes
-    the database of fortunes used by the Nechung Oracle Program.
+Retrieve a clone of the feisty meow code:
+=> git clone git://feistymeow.org/feisty_meow
 
-docs/
-    Assorted documentation files for Feisty Meow and a code-scanning documentation generator
-    based on doxygen.
+The remainder of these notes assume that the code is stored in
+~/feisty_meow (aka $HOME/feisty_meow).
 
-graphiq/
-    GUI tools and components, somewhat busted or just absent right now.
+==============
+How to load the feisty meow script environment
 
-octopi/
-    Octopus design pattern and CROMP protocol reference implementations.  Assorted applications
-    based on these.
+Set up the feisty_meow scripts; this is only needed once, when you first get
+the codebase.  It can also regenerate the scripts using the latest version.
+=> bash ~/feisty_meow/scripts/core/reconfigure_feisty_meow.sh
 
-production/
-    Machinery for getting releases out the door, including the generated files such as binaries
-    and build system tools.
+Load the script environment into the current shell.
+=> source ~/feisty_meow/scripts/core/launch_feisty_meow.sh
 
-scripts/
-    Stores the script files that we use a lot.  These are usually written in interpreted
-    languages, such as bash and perl.
+With the feisty meow script environment loaded, several aliases are now
+available for building the codebase and they are used in the sections below.
 
+Closing the current shell will lose the feisty meow environment.  Loading the
+environment can be made automatic by adding the 'source' line above to the
+shell's startup file.  Example startup files are available in:
+~/feisty_meow/feisty_inits
 
+==============
+How to install the feisty meow script dependencies
+
+A couple of perl modules are required by some of the scripts (including the
+differ utility and the feisty meow customization system).  They can be
+installed with either apt-get or CPAN.
+
+Install using apt-get:
+=> sudo apt-get install libfile-which-perl libtext-diff-perl
+
+or Install using perl's CPAN:
+=> sudo cpan install Text::Diff File::Which
+
+==============
+How to install the build dependencies for feisty meow
+
+| Ubuntu / Debian:
+| => sudo apt-get install build-essential librtmp-dev libcurl4-gnutls-dev libssl-dev
+
+| Centos / Redhat / Fedora:
+| => sudo yum install gcc gcc-c++ openssl-devel.x86_64 curl-devel
+
+| Microsoft Windows:
+| Download and install the Cygwin environment first from cygwin.com, which is
+| documented in ~/feisty_meow/documentation/cygwin_install_list.txt
+
+==============
+How to build the feisty meow codebase
+
+Run the following command to build the feisty meow libraries and applications.
+=> bash ~/feisty_meow/scripts/generator/produce_feisty_meow.sh
+
+After the build is complete, the feisty meow applications can be found in
+$FEISTY_MEOW_BINARIES (environment variable).
+=> ls $FEISTY_MEOW_BINARIES 
+
+==============
+How to clean up the files generated by the build
+
+This command cleans out all the generated files:
+=> bash ~/feisty_meow/scripts/generator/whack_build.sh clean
+
+==============
+What are the feisty meow dependencies?
+
+The feisty meow scripts depend on these scripting languages and tools:
+  bash
+  perl (including Text::Diff and File::Which)
+  python
+  gnumake
+
+The feisty meow libraries and applications depend on these tools:
+  Gnu C++
+  RTMP streams (?still?  not sure.)
+  Curl
+  Open SSL
+
+==============
+More information is available at the official site http://feistymeow.org