From 4cf49d8a42b89e213ed247765700db829aedbc6d Mon Sep 17 00:00:00 2001
From: Chris <46009390+thevirtuoso1973@users.noreply.github.com>
Date: Tue, 22 Mar 2022 13:59:10 +0000
Subject: [PATCH] Add toolchain file and update readme (#181)

* add toolchain file and update readme

* link to DEVELOPMENT.md

* fix install path
---
 README.md           | 22 ++++++++++++++++++++++
 rust-toolchain.toml |  5 +++++
 2 files changed, 27 insertions(+)
 create mode 100644 rust-toolchain.toml

diff --git a/README.md b/README.md
index 33ecaf6..a7ac3dc 100644
--- a/README.md
+++ b/README.md
@@ -9,3 +9,25 @@ Modus is a language for building OCI/Docker container images. Modus uses logic p
 - [Discord community](https://discord.gg/bXxwfVE9Kj)
 
 Modus uses semantic versioning; until version 1.0 is declared, breaking changes are possible. The current version, 0.1, is a preview release. We welcome bug reports and feature requests submitted through [GitHub Issues](https://github.com/mechtaev/modus/issues).
+
+# Installation
+
+Building Modus requires the [latest stable version of Rust](https://www.whatrustisit.com/), although
+versions 1.59+ may also work.
+
+``` sh
+cargo install modus
+```
+or 
+``` sh
+git clone https://github.com/modus-continens/modus.git
+cargo install --path ./modus/modus --profile release
+```
+Notice that this installs the binary at `modus/modus` (whereas the lib is in `modus/modus-lib`).
+
+Going forward, there will be pre-built executables for major platforms available with every Modus release.
+
+## Development - Custom Buildkit Frontend
+
+For development purposes, you may wish to use a `--custom-buildkit-frontend` to `modus build` an image.
+Use your `modus` installation from above and follow the instructions [here](./DEVELOPMENT.md).
diff --git a/rust-toolchain.toml b/rust-toolchain.toml
new file mode 100644
index 0000000..9618a17
--- /dev/null
+++ b/rust-toolchain.toml
@@ -0,0 +1,5 @@
+[toolchain]
+channel = "stable"
+components = [ "rustfmt", "rustc" ]
+targets = [ "x86_64-unknown-linux-gnu", "x86_64-unknown-linux-musl" ]
+profile = "minimal"