From 3df0806017ec8de173bedb2ca63ab089c39dfe81 Mon Sep 17 00:00:00 2001 From: Markus Triska Date: Sat, 1 Apr 2023 10:50:32 +0200 Subject: [PATCH 1/4] change "run" to "build", since "run" leads to a Scryer prompt which can be unexpected --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ed002d8d..97830007 100644 --- a/README.md +++ b/README.md @@ -115,12 +115,13 @@ distribution should be uninstalled from your system before rustup is used. Currently the only way to install the latest version of Scryer is to -clone directly from this git repository, which can be done as follows: +clone directly from this git repository, and compile the system. This +can be done as follows: ``` $> git clone https://github.com/mthom/scryer-prolog $> cd scryer-prolog -$> cargo run [--release] +$> cargo build [--release] ``` The optional `--release` flag will perform various optimizations, From b79d8732ea9da51ec76520193ae5056a28191f29 Mon Sep 17 00:00:00 2001 From: Markus Triska Date: Sat, 1 Apr 2023 10:59:32 +0200 Subject: [PATCH 2/4] use the release flag so that the instructions can be used verbatim Also, the location of the executable depends on this flag. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 97830007..a91ce449 100644 --- a/README.md +++ b/README.md @@ -121,11 +121,11 @@ can be done as follows: ``` $> git clone https://github.com/mthom/scryer-prolog $> cd scryer-prolog -$> cargo build [--release] +$> cargo build --release ``` -The optional `--release` flag will perform various optimizations, -producing a faster executable. +The `--release` flag performs various optimizations, producing a +faster executable. On Windows, Scryer Prolog is easier to build inside a [MSYS2](https://www.msys2.org/) environment as some crates may require native C compilation. However, From d6ac125425b3b26f6be1136e79ed8428edc084da Mon Sep 17 00:00:00 2001 From: Markus Triska Date: Sat, 1 Apr 2023 10:42:13 +0200 Subject: [PATCH 3/4] DOC: explain location of scryer-prolog after compilation This question was recently raised on the #scryer IRC channel. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index a91ce449..7cf8c129 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,9 @@ $> cargo build --release The `--release` flag performs various optimizations, producing a faster executable. +After compilation, the executable `scryer-prolog` is available in the +directory `target/release` and can be invoked to run the system. + On Windows, Scryer Prolog is easier to build inside a [MSYS2](https://www.msys2.org/) environment as some crates may require native C compilation. However, the resulting binary does not need MSYS2 to run. When executing Scryer in a shell, it is recommended to use a more advanced shell than mintty (the default MSYS2 shell). The [Windows Terminal](https://github.com/microsoft/terminal) works correctly. From b87fe1e21f2c509d85f9c2510146a7031c33f746 Mon Sep 17 00:00:00 2001 From: Markus Triska Date: Sat, 1 Apr 2023 10:42:58 +0200 Subject: [PATCH 4/4] DOC: link to "Indexing dif/2" --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7cf8c129..12ec6934 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Extend Scryer Prolog to include the following, among other features: - [x] Support for `attribute_goals/2` and `project_attributes/2` - [x] `call_residue_vars/2` - [x] `if_/3` and related predicates, following the developments of the - paper "Indexing `dif/2`". + paper "[Indexing `dif/2`](https://arxiv.org/abs/1607.01590)". - [x] All-solutions predicates (`findall/{3,4}`, `bagof/3`, `setof/3`, `forall/2`). - [x] Clause creation and destruction (`asserta/1`, `assertz/1`, `retract/1`, `abolish/1`) with logical update semantics.