@@ -20,28 +20,46 @@ Tenjin is The software-defined networking framework written in Rust, offering hi
## Menu
-[Installation to your project](#installation-to-your-project)
-[Installation for cli](#installation-for-cli)
-[Installation as Command line program](#installation-as-command-line-program)
-[Cli usage](#cli-usage)
-[Run The example controller](#run-The-example-controller)
-[Mininet](#mininet)
## Installation to your project
```
#### Normal install includes `full` feature by default.
```bash
cargo add tenjin_sdn
```
if you pefer to use with `example` Controller
#### if you pefer to use only needed library with lightweight and faster compile.
some features needed dependencies you might be not using,which can cause slow compilation.
Using only features you needed can decrease number of dependencies you need to compile.
```bash
cargo install tenjin_sdn --no-default-features
```
cargo install --features=example tenjin_sdn
if you need to use example controller, add `-F example` flag to command.
### Install Tokio
Tenjin is asynchronous,so for using it, you need to make your main function be async by using [tokio](https://tokio.rs/). install tokio with command below.
```bash
cargo add tokio
```
## Installation for cli
## Installation as Command line program
With Tenjin as cli you can run **The example controller** with your terminal without writing any code. (see example controller at ./src/example)
### Install [Rust](https://www.rust-lang.org/)
first, you need `rust` and `cargo` to install Tenjin as comand line program. go to official website for installation.
