Skip to content

Commit

Permalink
Merge pull request rajasekarv#121 from colindean/patch-1
Browse files Browse the repository at this point in the history
Mentions need for Rust Nightly
  • Loading branch information
rajasekarv authored Aug 14, 2020
2 parents 07c2e74 + 2b2ae61 commit 8533d4b
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions user_guide/src/chapter_1.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,27 @@

## Getting started

### Installation
### Setting up Rust

Right now the framework lacks any sort of cluster manager of submit program/script.
Vega requires Rust Nightly channel because it depends on libraries that require Nightly (`serde_traitobject` -> `metatype`).
Ensure that you have and are using a Nightly toolchain when
building examples.

In order to use the framework you have to clone the repository and add the local dependency or add the upstream GitHub repository to your Rust project (the crate is not yet published on [crates.io](https://crates.io/)). E.g. add to your application Cargo.toml or:
```doc
$ rustup toolchain install nightly
```

Then set the default, or pass the toolchain in when invoking Cargo:

```doc
$ rustup default nightly
```

### Installing Vega

Right now, the framework lacks any sort of cluster manager of submit program/script.

In order to use the framework, you have to clone the repository and add the local dependency or add the upstream GitHub repository to your Rust project (the crate is not yet published on [crates.io](https://crates.io/)). E.g. add to your application Cargo.toml or:

```doc
[dependencies]
Expand All @@ -17,7 +33,7 @@ vega = { path = "/path/to/local/git/repo" }
vega = { git = "https://github.com/rajasekarv/vega", branch = "master }
```

Is not recommended to use the application for any sort of production code yet as it's under heavy development.
It is _not recommended_ to use the application for any sort of production code yet as it's under heavy development.

Check [examples](https://github.com/rajasekarv/vega/tree/master/examples) and [tests](https://github.com/rajasekarv/vega/tree/master/tests) in the source code to get a basic idea of how the framework works.

Expand Down

0 comments on commit 8533d4b

Please sign in to comment.