From ba3fe347cc710db3bc22fbda8d2a3a01f22c3996 Mon Sep 17 00:00:00 2001 From: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com> Date: Fri, 12 Jan 2024 15:54:45 +0100 Subject: [PATCH] docs: Don't recommend building the CLI from source to new users (#161) In the docs we now link to the installers created by `cargo-dist`, which will automatically detect the user's platform and download the most appropriate CLI artifact. All scripts and artefacts are stored alongside their respective GitHub releases, but we proxy through https://pavex.dev/ to get shorter URLs and a way to target `latest`. --- docs/getting_started/index.md | 17 +++++++++++------ mkdocs.yml | 2 ++ 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/getting_started/index.md b/docs/getting_started/index.md index a8a33d728..485de2887 100644 --- a/docs/getting_started/index.md +++ b/docs/getting_started/index.md @@ -45,12 +45,17 @@ Pavex relies on `nightly` to perform code generation and compile-time reflection Pavex provides a command-line interface to scaffold new projects and work with existing ones. To install it, execute the following command: -```bash -cargo install --locked \ - --git "https://github.com/LukeMathWalker/pavex.git" \ - --branch "main" \ - pavex_cli -``` +=== "shell" + + ```bash + curl --proto '=https' --tlsv1.2 -LsSf https://pavex.dev/releases/download/latest/pavex_cli-installer.sh | sh + ``` + +=== "powershell" + + ```powershell + irm https://pavex.dev/releases/download/latest/pavex_cli-installer.ps1 | iex + ``` You can check that it's been installed correctly by running: diff --git a/mkdocs.yml b/mkdocs.yml index fce5cf1e4..efc8d847f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -25,6 +25,8 @@ markdown_extensions: - attr_list - md_in_html - footnotes + - pymdownx.tabbed: + alternate_style: true - pymdownx.highlight: anchor_linenums: true line_spans: __span