From 0b713ec519d4e099cb6ba3f4c3b9ef83476eaf5b Mon Sep 17 00:00:00 2001 From: Brett Cannon Date: Sat, 13 Feb 2021 19:15:34 -0800 Subject: [PATCH] Add installation instructions in the README --- Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 19 +++++++++++++++++++ 3 files changed, 21 insertions(+), 2 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index e6ef300..cb3ee2a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -353,7 +353,7 @@ dependencies = [ [[package]] name = "python-launcher" -version = "0.14.0" +version = "0.14.1" dependencies = [ "comfy-table", "exitcode", diff --git a/Cargo.toml b/Cargo.toml index 796de5c..410fcc1 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "python-launcher" description = "The Python launcher for Unix" -version = "0.14.0" +version = "0.14.1" authors = ["Brett Cannon "] repository = "https://github.com/brettcannon/python-launcher" readme = "README.md" diff --git a/README.md b/README.md index 82a7b15..675dcf3 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,25 @@ some time. See the top section of `py --help` for instructions. +## Installation + +You can either install from [crates.io](https://crates.io/) or from source. +Both approaches require you install the Rust toolchain. You can use +[rustup](https://rustup.rs/) to accomplish this or whatever your OS suggests. + +If you want to +[install from crates.io](https://crates.io/crates/python-launcher), run: + +```shell +cargo install python-launcher +``` + +If you want to install from source, run: + +```shell +cargo install --path . +``` + ## Search order Please note that while searching, the search for a Python version can become