Add installation instructions in the README

brettcannon · Feb 14, 2021 · 0b713ec · 0b713ec
1 parent 2f0b0ed
commit 0b713ec
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git 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 <brett@python.org>"]
 repository = "https://github.com/brettcannon/python-launcher"
 readme = "README.md"

diff --git 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