nice new tool to show version of feisty meow

[feisty_meow.git] / readme.txt

diff --git a/readme.txt b/readme.txt
index 9516af62461ddfa0102ed4a6b76a3bb5ec25e391..0fda046ea9e12470e4bf01335b68dc7ea8888cd7 100644 (file)
--- a/readme.txt
+++ b/readme.txt
@@ -1,42 +1,53 @@
 
 ==============
 
 ==============

+

 Quick Start Guide for the Feisty Meow Codebase
 
 Quick Start Guide for the Feisty Meow Codebase
 

-Commands that you should enter into your terminal are prefixed with "=>" and
-conditional portions are prefixed with a '|' character.
+Commands that can be typed in a console or terminal are are prefixed with "#".
+Information that varies by platform is prefixed with a '|' character.
+
+This documentation assumes that the code is stored in the default location:
+  /opt/feistymeow.org/feistymeow
+If you have stored it elsewhere, then please adapt the commands accordingly.

 
 ==============
 
 ==============

+

 How to get the feisty meow codebase
 
 | On Microsoft Windows, install the Cygwin tools as documented here:
 How to get the feisty meow codebase
 
 | On Microsoft Windows, install the Cygwin tools as documented here:

-| ~/feisty_meow/documentation/cygwin_install_list.txt (local file) or
+| /opt/feistymeow.org/feisty_meow/documentation/cygwin_install_list.txt (local file) or

 | https://feistymeow.org/feisty_meow/documentation/cygwin_install_list.txt (web)
 
 | https://feistymeow.org/feisty_meow/documentation/cygwin_install_list.txt (web)
 

-Retrieve a clone of the feisty meow code:
+Retrieve a clone of the feisty meow codebase:

 # git clone git://feistymeow.org/feisty_meow
 
 # git clone git://feistymeow.org/feisty_meow
 

-The remainder of these notes assume that the code is stored in
-~/feisty_meow (aka $HOME/feisty_meow).
-

 ==============
 ==============

+

 How to load the feisty meow script environment
 
 Set up the feisty_meow scripts; this is only needed once, when you first get
 How to load the feisty meow script environment
 
 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
-
-Load the script environment into the current shell.
-# source ~/feisty_meow/scripts/core/launch_feisty_meow.sh
-
-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
+the codebase.  It will also regenerate the scripts using the latest installed
+version.
+# bash /opt/feistymeow.org/feisty_meow/scripts/core/reconfigure_feisty_meow.sh
+
+Connect the feisty meow scripts to your login script (in ~/.bashrc).
+Note that this actually modifies ~/.bashrc.  This step is only needed once.
+# bash /opt/feistymeow.org/feisty_meow/scripts/core/connect_feisty_meow.sh
+
+Load the script environment into the current shell.  This can be done for
+any new shell.  This is idempotent, so it does no harm to run it again.
+Note that you should not need this step if you connected feisty meow to
+~/.bashrc above.
+# source /opt/feistymeow.org/feisty_meow/scripts/core/launch_feisty_meow.sh
+
+When the feisty meow script environment loaded, many new aliases and
+functions are available for use.  These come from the $FEISTY_MEOW_SCRIPTS
+folder.
+See the full list of commands at:
+(hmmm: To be completed in 2018)

 
 ==============
 
 ==============

+

 How to install the feisty meow script dependencies
 
 A couple of perl modules are required by some of the scripts (including the
 How to install the feisty meow script dependencies
 
 A couple of perl modules are required by some of the scripts (including the


@@ -50,35 +61,43 @@ or Install using perl's CPAN:
 # sudo cpan install Text::Diff File::Which
 
 ==============
 # sudo cpan install Text::Diff File::Which
 
 ==============

+

 How to install the build dependencies for feisty meow
 
 How to install the build dependencies for feisty meow
 

+These dependencies are used for building the applications, tools and tests
+in the "nucleus", "octopi", "graphiq" and other C++ collections.
+

 | 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
 
 | 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
+The "kona" collection depends on Java version 8 or better.
+
+| Ubuntu:
+| Set up the java PPA archive as described here:
+| https://launchpad.net/~webupd8team/+archive/ubuntu/java

 
 ==============
 
 ==============

+

 How to build the feisty meow codebase
 
 Run the following command to build the feisty meow libraries and applications.
 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
+# produce_feisty_meow

 
 After the build is complete, the feisty meow applications can be found in
 
 After the build is complete, the feisty meow applications can be found in

-$FEISTY_MEOW_BINARIES (environment variable).
-# ls $FEISTY_MEOW_BINARIES 
+the folder pointed at by the $FEISTY_MEOW_BINARIES environment variable.

 
 ==============
 
 ==============

+

 How to clean up the files generated by the build
 
 This command cleans out all the generated files:
 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
+# whack_build clean

 
 ==============
 
 ==============

+

 What are the feisty meow dependencies?
 
 The feisty meow scripts depend on these scripting languages and tools:
 What are the feisty meow dependencies?
 
 The feisty meow scripts depend on these scripting languages and tools:


@@ -93,6 +112,24 @@ The feisty meow libraries and applications depend on these tools:
   Curl
   Open SSL
 
   Curl
   Open SSL
 

+The feisty meow "kona" library depends on these languages:
+  Java
+
+==============
+
+Bug reporting
+
+Report bugs at the feisty meow trac site:
+https://trac.feistymeow.org/projects/feistymeow/report
+Email fred@gruntose.com for authorization to write up new bug reports.
+
+There is also a github mirror of feisty meow at:
+https://github.com/fredhamster/feisty_meow
+The github repository will accept bug reports without an authorization process.
+
+==============
+
+More information is available at the official site: https://feistymeow.org
+

 ==============
 ==============

-More information is available at the official site http://feistymeow.org