From 57598a876d532dcd7ab784926e4e6fc5005655f8 Mon Sep 17 00:00:00 2001 From: Dmitriy Pleshevskiy Date: Tue, 31 Dec 2019 09:32:45 +0300 Subject: [PATCH] chore: remove rocket example from members --- Cargo.toml | 2 +- examples/rocket/Cargo.toml | 2 +- examples/rocket/README.md | 23 +++++++++++++++++++++++ itconfig/src/lib.rs | 2 +- 4 files changed, 26 insertions(+), 3 deletions(-) create mode 100644 examples/rocket/README.md diff --git a/Cargo.toml b/Cargo.toml index f88ef93..9a0afd0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,5 +3,5 @@ members = [ "itconfig", "itconfig_tests", "examples/diesel", - "examples/rocket", +# "examples/rocket", ] diff --git a/examples/rocket/Cargo.toml b/examples/rocket/Cargo.toml index 4b9f0cc..1a2f366 100644 --- a/examples/rocket/Cargo.toml +++ b/examples/rocket/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "rocket" +name = "itconfig-rocket-example" version = "0.1.0" authors = ["Dmitriy Pleshevskiy "] edition = "2018" diff --git a/examples/rocket/README.md b/examples/rocket/README.md new file mode 100644 index 0000000..3a2ccbd --- /dev/null +++ b/examples/rocket/README.md @@ -0,0 +1,23 @@ + +# itconfig rocket example + + +### Installation + +To install a nightly version of Rust, we recommend using rustup. Install rustup by following the instructions on its website. Once rustup is installed, configure Rust nightly as your default toolchain by running the command: + +`rustup default nightly` + +If you prefer, once we setup a project directory in the following section, you can use per-directory overrides to use the nightly version only for your Rocket project by running the following command in the directory: + +`rustup override set nightly` + + + +### Usage + +```bash +cd examples/rocket + +cargo run +``` diff --git a/itconfig/src/lib.rs b/itconfig/src/lib.rs index f32a7e0..9f83715 100644 --- a/itconfig/src/lib.rs +++ b/itconfig/src/lib.rs @@ -192,7 +192,7 @@ impl From for String { /// -------------------------------------------- /// /// ```rust -/// pub fn init(); +/// pub fn init() {} /// ``` /// /// Run this at the main function for check all required variables without default value.