Merge branch 'master' of feistymeow.org:feisty_meow

[feisty_meow.git] / readme.txt

diff --git a/readme.txt b/readme.txt
index aaa8283b77d290095a210d1b309b9797cd16beef..7d78391e8e32676d1f303bde6873421fa8ffa1ee 100644 (file)
--- a/readme.txt
+++ b/readme.txt
@@ -3,7 +3,8 @@
 
 Quick Start Guide for the Feisty Meow Codebase
 
-Commands that can be typed in a console or terminal are are prefixed with "#".
+Commands that can be typed in a console or terminal are are prefixed with "$".
+(Do not include the dollar sign when copying and pasting commands.)
 Information that varies by platform is prefixed with a '|' character.
 
 This documentation assumes that the code is stored in the default location:
@@ -19,20 +20,19 @@ How to get the feisty meow codebase
 | 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
+$ git clone git://feistymeow.org/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
-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
+the codebase.
+$ 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
+$ bash /opt/feistymeow.org/feisty_meow/scripts/core/connect_feisty_meow.sh
 
 | For the root user, you can pass a flag '--root' to the connect_feisty_meow
 | script.  This will add an alias for 'feistyme' which loads the feisty meow
@@ -42,13 +42,13 @@ 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
+$ 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)
+There is a list of feisty meow script commands available at:
+https://feistymeow.org/feisty_meow/documentation/feisty_meow_command_reference.txt
 
 ==============
 
@@ -56,16 +56,28 @@ 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.
+installed with either apt or CPAN.
 
-Install using apt-get (on Ubuntu or Debian-based OS):
-# sudo apt-get install libfile-which-perl libtext-diff-perl
+Install using apt (on Ubuntu or Debian-based OS):
+$ sudo apt install libfile-which-perl libtext-diff-perl
 
 or Install using perl's CPAN:
-# sudo cpan install Text::Diff File::Which
+$ sudo cpan install Text::Diff File::Which
 
 or on Cygwin (MS-Windows), install with apt-cyg:
-# apt-cyg install perl-File-Which perl-Text-Diff
+$ apt-cyg install perl-File-Which perl-Text-Diff
+
+==============
+
+How to update the feisty meow codebase to the latest online version
+
+This assumes that a somewhat current version of feisty meow is already
+installed and the scripts are loaded (see above section for how to load).
+
+The command below retrieves the latest version of feisty meow codebase
+from the online repository and regenerates the scripts.
+
+$ rpuffer $FEISTY_MEOW_APEX ; regenerate
 
 ==============
 
@@ -75,10 +87,10 @@ 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
+| $ sudo apt 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
+| $ sudo yum install gcc gcc-c++ openssl-devel.x86_64 curl-devel
 
 The "kona" collection depends on Java version 8 or better.
 
@@ -91,7 +103,7 @@ The "kona" collection depends on Java version 8 or better.
 How to build the feisty meow codebase
 
 Run the following command to build the feisty meow libraries and applications.
-# produce_feisty_meow
+$ produce_feisty_meow
 
 After the build is complete, the feisty meow applications can be found in
 the folder pointed at by the $FEISTY_MEOW_BINARIES environment variable.
@@ -101,7 +113,7 @@ 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:
-# whack_build clean
+$ whack_build clean
 
 ==============