Skip to content

Commit

Permalink
Minor documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
pmoura committed Feb 1, 2014
1 parent 8b49ce0 commit 1d29a33
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 2 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,9 @@ Most directories include `NOTES.md` documenting files, which can be viewed
as plain text in any text editor but also nicely rendered as Markdown files
(for e.g. easy conversion to HTML).

On POSIX systems, there's also a man page for each shell script. A list of
all the scripts can be generated using the `apropos logtalk` command.


9. UPGRADING
------------
Expand Down
2 changes: 1 addition & 1 deletion paths/NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Windows, Linux, Unix, and Unix-like operating-systems.
Although you could customize this file by adding the paths to your own
"libraries" (in order to easily load your own source code), this is
preferably accomplished by customizing the settings file in the Logtalk
user directory.
user directory or in your Logtalk application directory.

When manually loading Logtalk (instead of using the provided integration
scripts and shortcuts), you will need to load the `paths.pl` into your
Expand Down
3 changes: 2 additions & 1 deletion scratch/NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,5 @@ by the Logtalk compiler at startup. If you delete this folder by accident,
it will be recreated the next time you run Logtalk.

You may set the value of the `scratch_directory` to this folder if you
want to collect all temporary files in the same location.
want to collect in the same location the Prolog temporary files that are
generated when compiling Logtalk source files.
3 changes: 3 additions & 0 deletions scripts/NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ they require WSH 5.6 or later version to be installed and should be run
using `cscript.exe` from a DOS command line shell (you may download WSH 5.6
from `http://msdn.microsoft.com/downloads/list/webdev.asp`).

Man pages are provided for all POSIX shell scripts, which can be listed
using the `apropos logtalk` command.

- `build_release.sh`
helper script for building most of the distribution files of a new
Logtalk release; accepts as an optional argument a version identifier
Expand Down

0 comments on commit 1d29a33

Please sign in to comment.