Skip to content

Commit

Permalink
Remove installation from pre-compiled binaries from the docs for now
Browse files Browse the repository at this point in the history
  • Loading branch information
Veetaha committed Sep 19, 2023
1 parent 81c6e1c commit 95063b0
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 44 deletions.
17 changes: 0 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,23 +39,6 @@ The following is an abbreviated guide. Check out [The Marker Book] for detailed

### Installation

#### Download pre-compiled binaries (recommended)

We provide pre-compiled binaries for the mainstream platforms. See the list of available artifacts in our [Github Releases](https://github.com/rust-marker/marker/releases/latest).

On UNIX-like systems, you can run the following bash script. It will install the required rust toolchain dependency on your machine, download the current version of `cargo-marker` CLI, and the internal driver.

<!-- region replace-version stable -->
```bash
curl --location --silent --fail --show-error --retry 5 --retry-connrefused \
https://raw.githubusercontent.com/rust-marker/marker/v0.2.1/scripts/release/install.sh | bash
```
<!-- endregion replace-version stable -->

The provided scripts are pinned to a specific version of `marker` to avoid sudden breakages especially if this script will be used on CI.

If you are a windows user or your platform isn't supported yet by the pre-compiled binaries, then you should fall back to building from sources as described below.

#### Build from sources

```sh
Expand Down
17 changes: 0 additions & 17 deletions docs/book/src/usage/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,6 @@ The marker sub-command is provided by the *cargo_marker* crate. This crate requi
[Cargo]: https://github.com/rust-lang/cargo/
[rustup]: https://github.com/rust-lang/rustup/

## Download pre-compiled binaries (recommended)

We provide pre-compiled binaries for the mainstream platforms. See the list of available artifacts in our [Github Releases](https://github.com/rust-marker/marker/releases/latest).

On UNIX-like systems, you can run the following bash script. It will install the required rust toolchain dependency on your machine, download the current version of `cargo-marker` CLI, and the internal driver.

<!-- region replace-version stable -->
```bash
curl --location --silent --fail --show-error --retry 5 --retry-connrefused \
https://raw.githubusercontent.com/rust-marker/marker/v0.2.1/scripts/release/install.sh | bash
```
<!-- endregion replace-version stable -->

The provided scripts are pinned to a specific version of `marker` to avoid sudden breakages especially if this script will be used on CI.

If you are a windows user or your platform isn't supported yet by the pre-compiled binaries, then you should fall back to building from sources as described below.

## Build `cargo marker` plugin from sources

Marker provides a new Cargo sub-command, that handles the driver installation, lint crate compilation, and checking process for you. To install it, simply use:
Expand Down
10 changes: 0 additions & 10 deletions scripts/release/snapshot.diff
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,6 @@
# endregion replace-version dev

=== README.md ===
curl --location --silent --fail --show-error --retry 5 --retry-connrefused \
- https://raw.githubusercontent.com/rust-marker/marker/v<version>/scripts/release/install.sh | bash
+ https://raw.githubusercontent.com/rust-marker/marker/v0.1.0/scripts/release/install.sh | bash
```
# An external crate from a registry
-marker_lints = "<version>"
+marker_lints = "0.1.0"
Expand Down Expand Up @@ -93,12 +89,6 @@
+ cli_example = display::cli(r#"cargo marker --lints "marker_lints = '0.1.0'""#),
lints = "--lints".blue(),

=== docs/book/src/usage/installation.md ===
curl --location --silent --fail --show-error --retry 5 --retry-connrefused \
- https://raw.githubusercontent.com/rust-marker/marker/v<version>/scripts/release/install.sh | bash
+ https://raw.githubusercontent.com/rust-marker/marker/v0.1.0/scripts/release/install.sh | bash
```

=== docs/book/src/usage/lint-crate-declaration.md ===
# An external crate from a registry
-marker_lints = "<version>"
Expand Down

0 comments on commit 95063b0

Please sign in to comment.