Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
m1ten committed Mar 3, 2024
1 parent 6f733f4 commit 013321d
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,41 +4,43 @@

# krait

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/m1ten/krait/compile%20and%20release%20krait%20unstable)](https://github.com/m1ten/krait/actions/workflows/unstable.yml) [![rustc version](https://img.shields.io/badge/rust-stable-orange?logo=rust)](https://www.rust-lang.org/) [![Apache-2.0](https://img.shields.io/badge/license-Apache-blue?logo=apache)](./LICENSE)
[![rustc version](https://img.shields.io/badge/rust-stable-orange?logo=rust)](https://www.rust-lang.org/) [![Apache-2.0](https://img.shields.io/badge/license-Apache-blue?logo=apache)](./LICENSE)

<!-- [![crates.io](https://img.shields.io/crates/v/krait)](https://crates.io/crates/krait) -->

cross platform package manager
cross platform package manager and automation tool

## Installation

Download the latest binary from [releases](https://github.com/m1ten/krait/releases)
Download the latest binary from [releases](https://github.com/m1ten/krait/releases). All 3 major platforms are supported (Universal binaries for macOS will be available soon).

```sh
# POSIX: Give execution permission to krait and run
$ chmod +x krait && ./krait
chmod +x krait && ./krait

# Windows: Run the exe
$ .\krait.exe
.\krait.exe
```

### Building from source

1. Install dependencies

1. [Rust nightly](https://rust-lang.github.io/rustup/concepts/channels.html) using [`rustup`](https://www.rust-lang.org/tools/install)
1. [Rust stable](https://rust-lang.github.io/rustup/concepts/channels.html) using [`rustup`](https://www.rust-lang.org/tools/install)

```sh
$ rustup toolchain install nightly
rustup toolchain install stable
```

2. Clone the [source](https://github.com/m1ten/krait) using [`git`](https://git-scm.com/)

```sh
$ git clone https://github.com/m1ten/krait.git
$ cd krait
git clone https://github.com/m1ten/krait.git
cd krait
```

3. Build and run using [`cargo`](https://doc.rust-lang.org/stable/cargo/)

```sh
$ cargo +nightly run --release
cargo +stable run --release
```

0 comments on commit 013321d

Please sign in to comment.