nice new tool to show version of feisty meow
[feisty_meow.git] / readme.txt
index c089a4e771d71a261e8d19bb65f730bb0f0e5d3b..0fda046ea9e12470e4bf01335b68dc7ea8888cd7 100644 (file)
@@ -6,20 +6,21 @@ Quick Start Guide for the Feisty Meow Codebase
 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:
-| ~/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)
 
 Retrieve a clone of the feisty meow codebase:
 # 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
@@ -27,17 +28,17 @@ 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 will also regenerate the scripts using the latest installed
 version.
-# bash ~/feisty_meow/scripts/core/reconfigure_feisty_meow.sh
+# 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 ~/feisty_meow/scripts/core/connect_feisty_meow.sh
+# 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 ~/feisty_meow/scripts/core/launch_feisty_meow.sh
+# 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
@@ -72,10 +73,6 @@ in the "nucleus", "octopi", "graphiq" and other C++ collections.
 | 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:
@@ -90,8 +87,7 @@ Run the following command to build the feisty meow libraries and applications.
 # produce_feisty_meow
 
 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.
 
 ==============