From d3f5f78ff13beb0361501cb92e97b14c52b86048 Mon Sep 17 00:00:00 2001 From: Colin Dean Date: Thu, 13 Aug 2020 12:01:01 -0400 Subject: [PATCH 1/2] Mentions need for Rust Nightly Direct dependency `serde_traitobject` 0.2.4 depends on `metatype` 0.2.0, which requires nightly. --- user_guide/src/chapter_1.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/user_guide/src/chapter_1.md b/user_guide/src/chapter_1.md index 0192c9c0..58751eff 100644 --- a/user_guide/src/chapter_1.md +++ b/user_guide/src/chapter_1.md @@ -4,11 +4,23 @@ ## 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: + rustup toolchain install nightly + +Then set the default, or pass the toolchain in when invoking Cargo: + + 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] @@ -17,7 +29,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. From 2b2ae610fb1cac2adfb40f0978e8bba938e98cc2 Mon Sep 17 00:00:00 2001 From: Colin Dean Date: Thu, 13 Aug 2020 12:31:37 -0400 Subject: [PATCH 2/2] Fixes code block style so it's not executed --- user_guide/src/chapter_1.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/user_guide/src/chapter_1.md b/user_guide/src/chapter_1.md index 58751eff..f673d82d 100644 --- a/user_guide/src/chapter_1.md +++ b/user_guide/src/chapter_1.md @@ -10,11 +10,15 @@ Vega requires Rust Nightly channel because it depends on libraries that require Ensure that you have and are using a Nightly toolchain when building examples. - rustup toolchain install nightly +```doc +$ rustup toolchain install nightly +``` Then set the default, or pass the toolchain in when invoking Cargo: - rustup default nightly +```doc +$ rustup default nightly +``` ### Installing Vega