Changeset 1730 for trunk/INSTALL

Timestamp:

11/27/04 12:42:44 (4 years ago)

Author:

pmoura

Message:

Improved installation and configuration instructions.

Files:

• trunk/INSTALL (modified) (9 diffs)

trunk/INSTALL

@@ -23 +23 @@
 
 In the case of a single user, the Logtalk directory may simply be copied to 
-the user home directory.
+the user home directory. In alternative, assuming a user with administrative 
+rights, the same setup described below for multiple users may be applied. 
+This has the advantage of allowing the user to freely try and modify the 
+provided examples, library, and configuration files with the option of, at 
+any time, restoring the files to its original state by simply running one of 
+the provided scripts.
 
 
@@ -33 +38 @@
 feasible or desired).
 
-The "misc" sub-directory contains some shell scripts for easy installation 
-of Logtalk on Windows, Unix, and Unix-like operating systems (for details, 
+The "misc" sub-directory contains shell scripts for easy installation of 
+Logtalk on Windows, Unix, and Unix-like operating systems (for details, 
 see the misc/NOTES file). These scripts make all files read-only in order 
 to avoid user tempering. However, Logtalk directories such as "library" 
@@ -44 +49 @@
 world-writable is a security risk, one solution is to copy the directories 
 that need to be user-writable to each user home directory. The "misc" sub-
-directory contains shell scripts (named cplgtdirs.*) which may be called 
-by the end-users for making such copies.
+directory contains shell scripts (named "cplgtdirs.*") which may be called 
+by the end-users for making such copies. This is the preferred setup for a 
+computer lab. When used with one of the Prolog compilers for which an 
+integration script is provided on the "misc" directory, this setup allows 
+end-users to independently customize default compilation options and 
+library paths.
 
 
@@ -56 +65 @@
 directory. The environment variable LOGTALKUSER should point to a directory 
 in your home directory where you want to store the user-specific Logtalk files
-(for example, ~/logtalk). Both environment variables can be set for all users 
+(for example, ~/logtalk). Both environment variables may be set for all users 
 by a user with administration privileges. The two environment variables can 
 have the same value if you are the only Logtalk user on your computer and if 
-you have full permissions to the Logtalk installation directory.
-
-In addition, you may want to add the Logtalk sub-directory "xml", which 
-contains useful scripts for processing XML documenting files, to your 
-execution path.
+you have full permissions to the Logtalk installation directory. In addition, 
+you may want to add the Logtalk sub-directory "xml", which contains useful 
+scripts for processing XML documenting files, to your execution path.
 
 * Unix and Unix-like systems:
@@ -87 +94 @@
 * Windows systems:
 
-In Windows 95/98/ME, environment variables are defined in the autoexec.bat 
+In Windows 95/98/ME, environment variables are defined in the "autoexec.bat" 
 file (you will need to reboot after editing the file):
 
@@ -104 +111 @@
 paths can be declared using a dynamic predicate. This allows compiling and 
 loading of libraries and library files to be performed without worries about 
-library paths. In the compiler directory you will find some template files 
-which you can copy and edit to match your Logtalk installation and your Prolog 
-compiler and operating-system requirements. See the libpaths/NOTES file for 
+library paths. In the "libpaths" directory you will find a sample file which 
+you can copy and edit to match your Logtalk installation and your Prolog 
+compiler and operating-system requirements. See the "libpaths/NOTES" file for 
 more details.
 
@@ -113 +120 @@
 
 Logtalk interfaces with a specific Prolog compiler via a configuration file 
-that can be found on the $LOGTALKUSER/configs directory. These configuration 
+that can be found on the "$LOGTALKUSER/configs" directory. These configuration 
 files can be customized by changing the values of the default flags and 
 compiler options which are used by Logtalk when compiling source files. For 
@@ -121 +128 @@
 "underscore_vars", "startup_message", "smart_compilation", and the set of 
 documentation-related flags ("xml", "xsl", "xmlspec", and "doctype"). Be sure 
-to read the $LOGTALKHOME/configs/NOTES file for Prolog specific notes; some 
+to read the "$LOGTALKUSER/configs/NOTES" file for Prolog specific notes; some 
 Prolog compilers do not support the whole range of compilation flags.  
 
@@ -132 +139 @@
 and the Logtalk compiler. The "misc" sub-directory contains several scripts 
 for automating the creation of these initialization files for some Prolog 
-compilers. In addition, be sure to read the configs/NOTES file notes on the 
+compilers. In addition, be sure to read the "configs/NOTES" file notes on the 
 Prolog compilers that you intend to use.