From 93532480d7b9ed4cc4247b662bb996e5d12585c9 Mon Sep 17 00:00:00 2001 From: Chip Senkbeil Date: Sun, 1 Aug 2021 22:40:17 -0500 Subject: [PATCH] Add installation section to readme --- .gitignore | 1 + README.md | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+) diff --git a/.gitignore b/.gitignore index ea8c4bf..0592392 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ /target +.DS_Store diff --git a/README.md b/README.md index a9df773..e9f7b89 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,25 @@ talk to the server. - [BLAKE2b-256](https://www.blake2.net/) in keyed mode for a second authentication - [Elliptic Curve Diffie-Hellman](https://en.wikipedia.org/wiki/Elliptic-curve_Diffie%E2%80%93Hellman) (ECDH) for key exchange +## Installation + +### Prebuilt Binaries + +If you would like a pre-built binary, check out the +[releases section](https://github.com/chipsenkbeil/distant/releases). + +### Building from Source + +If you have [`cargo`](https://github.com/rust-lang/cargo) installed, you can +directly download and build the source via: + +```bash +cargo install distant +``` + +Alternatively, you can clone this repository and build from source following +the [build guide](./BUILDING.md). + ## Examples Launch a remote instance of `distant` by SSHing into another machine and