From 143430dd9c5e90681abc39208a6f6dbae054ffeb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bennet=20Ble=C3=9Fmann?= <3877590+Skgland@users.noreply.github.com> Date: Thu, 23 Jan 2025 19:11:08 +0100 Subject: [PATCH 1/6] Update README.md --- README.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1e7cb24b..1dac50c3 100644 --- a/README.md +++ b/README.md @@ -125,10 +125,15 @@ Rust updated to the latest stable release; any existing Rust distribution should be uninstalled from your system before rustup is used. +The minimum rust toolchain version required can be found in the [Cargo.toml](https://github.com/mthom/scryer-prolog/blob/master/Cargo.toml#L13) +under the `package.rust-version` key. + Currently the only way to install the latest version of Scryer is to clone directly from this git repository, and compile the system. This can be done as follows: +### From a local git checkout + ``` $> git clone https://github.com/mthom/scryer-prolog $> cd scryer-prolog @@ -141,6 +146,32 @@ faster executable. After compilation, the executable `scryer-prolog` is available in the directory `target/release` and can be invoked to run the system. +### Via `cargo install` + +#### From git + +``` +cargo install --locked --git https://github.com/mthom/scryer-prolog.git +``` + +Afterwards the binary will be under `$HOME/.cargo/bin` which is usually added to your PATH +during the installation of the rust toolchain. + +#### From Crates.io [![Crates.io Version](https://img.shields.io/crates/v/scryer-prolog)](https://crates.io/crates/scryer-prolog) ![Crates.io MSRV](https://img.shields.io/crates/msrv/scryer-prolog) + +> [!NOTE] +> The lates crates.io release can be significantly behind the version available in the git repository +> The crates.io badge in this sections title is a link to the crates.io page. +> The msrv badge in the section title referece to the minimum rust toolchain version required to compile the latest crates.io release + +`scryer-prolog` is also release on crates.io and can be installed with + +``` +cargo install --locked scryer-prolog +``` + +### Caveates for Windows + 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. @@ -152,8 +183,6 @@ light.exe scryer-prolog.wixobj ``` It will generate a very basic MSI file which installs the main executable and a shortcut in the Start Menu. It can be installed with a double-click. To uninstall, go to the Control Panel and uninstall as usual. -Scryer Prolog must be built with **Rust 1.70 and up**. - ### Building WebAssembly Scryer Prolog has basic WebAssembly support. You can follow `wasm-pack`'s [official instructions](https://rustwasm.github.io/docs/wasm-pack/quickstart.html) to install `wasm-pack` and build it in any way you like. From f1100271e27d7a46f13b586f1f0db3a4eb53a221 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bennet=20Ble=C3=9Fmann?= <3877590+Skgland@users.noreply.github.com> Date: Thu, 23 Jan 2025 19:18:15 +0100 Subject: [PATCH 2/6] Update README.md --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1dac50c3..f59d8f4a 100644 --- a/README.md +++ b/README.md @@ -125,12 +125,11 @@ Rust updated to the latest stable release; any existing Rust distribution should be uninstalled from your system before rustup is used. -The minimum rust toolchain version required can be found in the [Cargo.toml](https://github.com/mthom/scryer-prolog/blob/master/Cargo.toml#L13) -under the `package.rust-version` key. -Currently the only way to install the latest version of Scryer is to -clone directly from this git repository, and compile the system. This -can be done as follows: +> [!NOTE] +> The minimum rust toolchain version required can be found in the [Cargo.toml](https://github.com/mthom/scryer-prolog/blob/master/Cargo.toml#L13) +under the `package.rust-version` key. +> The acurracy of this values is validated in CI ### From a local git checkout From 75d499bf8a11ee94c21a59f572ab22b9f007ea84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bennet=20Ble=C3=9Fmann?= <3877590+Skgland@users.noreply.github.com> Date: Thu, 23 Jan 2025 19:20:19 +0100 Subject: [PATCH 3/6] update install link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f59d8f4a..c582edc6 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ at: ### Native Compilation First, install the latest stable version of -[Rust](https://www.rust-lang.org/en-US/install.html) using your +[Rust](https://www.rust-lang.org/tools/install) using your preferred method. Scryer tends to use features from newer Rust releases, whereas Rust packages in Linux distributions, Macports, etc. tend to lag behind. [rustup](http://rustup.rs) will keep your From b1e66f686b6a5c5a2a04294c242246fa653036e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bennet=20Ble=C3=9Fmann?= <3877590+Skgland@users.noreply.github.com> Date: Thu, 23 Jan 2025 20:04:43 +0100 Subject: [PATCH 4/6] Update README.md fix ambiguity regarding the install location for the cargo install method, also include the binary name --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c582edc6..201c736c 100644 --- a/README.md +++ b/README.md @@ -153,7 +153,7 @@ directory `target/release` and can be invoked to run the system. cargo install --locked --git https://github.com/mthom/scryer-prolog.git ``` -Afterwards the binary will be under `$HOME/.cargo/bin` which is usually added to your PATH +Afterwards the `scryer-prolog` binary will be in the `$HOME/.cargo/bin` directory which is usually added to your PATH during the installation of the rust toolchain. #### From Crates.io [![Crates.io Version](https://img.shields.io/crates/v/scryer-prolog)](https://crates.io/crates/scryer-prolog) ![Crates.io MSRV](https://img.shields.io/crates/msrv/scryer-prolog) From a7598184bf78985fd57215704542ef1d198c788e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bennet=20Ble=C3=9Fmann?= <3877590+Skgland@users.noreply.github.com> Date: Fri, 24 Jan 2025 18:47:42 +0100 Subject: [PATCH 5/6] fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 201c736c..07b09cd0 100644 --- a/README.md +++ b/README.md @@ -169,7 +169,7 @@ during the installation of the rust toolchain. cargo install --locked scryer-prolog ``` -### Caveates for Windows +### Caveats for Windows 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 7a5a5bb7956131cceda90f1aad47acb6fea06ffd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bennet=20Ble=C3=9Fmann?= Date: Mon, 27 Jan 2025 20:40:12 +0100 Subject: [PATCH 6/6] fix spelling and grammar errors found by mthom https://github.com/mthom/scryer-prolog/pull/2791#discussion_r1930025598 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 07b09cd0..0e8438d4 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ used. > [!NOTE] > The minimum rust toolchain version required can be found in the [Cargo.toml](https://github.com/mthom/scryer-prolog/blob/master/Cargo.toml#L13) under the `package.rust-version` key. -> The acurracy of this values is validated in CI +> The accuracy of this value is validated in CI ### From a local git checkout