Skip to content
This repository has been archived by the owner on Aug 2, 2024. It is now read-only.

Commit

Permalink
Add toolchain file and update readme (#181)
Browse files Browse the repository at this point in the history
* add toolchain file and update readme

* link to DEVELOPMENT.md

* fix install path
  • Loading branch information
thevirtuoso1973 authored Mar 22, 2022
1 parent 526e955 commit 4cf49d8
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
5 changes: 5 additions & 0 deletions rust-toolchain.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[toolchain]
channel = "stable"
components = [ "rustfmt", "rustc" ]
targets = [ "x86_64-unknown-linux-gnu", "x86_64-unknown-linux-musl" ]
profile = "minimal"

0 comments on commit 4cf49d8

Please sign in to comment.