Skip to content
This repository has been archived by the owner on Apr 21, 2019. It is now read-only.

Commit

Permalink
Merge pull request #1 from charlespierce/compile_instructions
Browse files Browse the repository at this point in the history
Add section describing how to build and install from source
  • Loading branch information
dherman authored Mar 1, 2019
2 parents 277ecf4 + eed69e9 commit ac04ca1
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions _contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,32 @@ Contribution to Notion is organized under the terms of the [Contributor Covenant

Notion is intended to compile with [Rust 1.33](https://www.rust-lang.org/) or newer.

### Building

To compile Notion from source, use [Cargo](https://doc.rust-lang.org/cargo/index.html):

```sh
cargo build
```

### Installing Local Builds

To install a locally built copy of Notion, you can use the helper scripts provided in the `dev` directory:

```sh
cargo build
./dev/unix/build.sh debug
./dev/unix/install.sh
```

Or:

```sh
cargo build --release
./dev/unix/build.sh
./dev/unix/install.sh
```

### Formatting

We use Rust's official [rustfmt](https://github.com/rust-lang/rustfmt) tool in our CI to ensure consistent style in the Notion codebase.
Expand Down

0 comments on commit ac04ca1

Please sign in to comment.