From 1f52ad61b07333701f6a947b4b51bf91b719a2b1 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Sun, 7 Jun 2020 20:15:51 -0500 Subject: [PATCH] Update: main readme documentation. This documentation is in an FSS format. The other documentation files will likely be converted to the same FSS format in the near future. --- documents/readme.txt | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/documents/readme.txt b/documents/readme.txt index 63be49f..865b395 100644 --- a/documents/readme.txt +++ b/documents/readme.txt @@ -5,35 +5,34 @@ Installation: The FLL provides two installation types\: - - The bootstrap scripts. + - The management scripts. - The Featureless Make program. - The bootstrap scripts provide a way to build and compile the entire FLL project, without the Fake program. - This is done because the Fake program is actually part of the FLL project. - This solves the problem that if you don't already have Fake installed, then you cannot install Fake. + The management scripts provide a way to manage the source code, such as updating dependencies, constructing the souce code for release, and bootstrap compiling the system. + + The bootstrap compiling provides a way to build and compile the entire FLL project, without the Featureless Make (Fake) program. + This bootstrap process solves the problem where if you don't already have Fake installed, then you cannot install Fake. - The bootstrap scripts also provide a way to convert the source code of the FLL into packages for compiling and/or releasing. The source code needs to be packaged before it can be compiled by either the bootstrap scripts or by the Fake program. The Fake program is not intended to be used as an installer, so the bootstrap scripts also provide an install script. This install script is intended to be used only by the FLL. Future versions of the FLL may include an install equivalent to the Fake program (and there may possibly be a package generation equivalent as well). - The bootstrap scripts are as follows\: + The management scripts are as follows\: - bootstrap.sh - - generate.sh + - bootstrap-example.sh - install.sh - package.sh - The boostrap.sh script is intended to be a functional example of the command line arguments that should be used to generate, compile, and install the entire FLL. + The bootstrap.sh script is intended to take the FLL source code and compile it into appropriate binaries on the system, particularly when the Fake program is not installed. + This is analogous to the GNU Make program and the FLL Fake program. - The generate.sh script is intended to take the FLL source code and compile it into appropriate binaries on the system, particularly when the Fake program is not installed. - This is analogous to the GNU Make program and the FLL Fake progam. + The bootstrap-example.sh script is intended to be a functional example of the command line arguments that should be used to generate, compile, and install the entire FLL. - The install.sh script is intended to install the FLL onto the system. + The install.sh script is intended to install the built and compiled FLL code onto the system. This script very loosely follows a small amount of the logic of configure scripts. - The package.sh script is intended to convert the FLL source code from the source code repository structure into a packaged structure. - This should be used regadless of whether or not Fake or the generate.sh is used to build/compile the FLL (or any of its parts). - Of particular note is that there are multiple ways to package the FLL, such as each package as its own program, each package by level, or each package as a monolithic library. - + The package.sh script is intended to convert the FLL source code from the source code repository structure into a packaged or release. + Of particular note is that there are multiple ways to package the FLL, such as each package as its own individual project, each package by level, or each package as a monolithic library. + This script also provides management functions for ensuring the dependencies and configuration settings are accurate. -- 1.8.3.1