diff --git a/README.md b/README.md index db8125e..96826b8 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,28 @@ rust libraries in the domain of ML, you might want to check out: * [rustlearn] * [leaf]. +Getting Started +--------------- + +1. Install the rust package manager `cargo`. Goto [rustup] and follow the instructions on + the page (in my experience this works fine for Windows, Ubuntu and OS X). +2. Run `cargo new --bin hello_vikos`. +3. switch to the `hello_vikos` directory. +4. Run `cargo run` to execute the hello world program. +3. Edit the `Cargo.toml` file. Add `vikos = "0.1.6"` to your dependencies. The file should + now look somewhat like this: + ``` + [package] + name = "hello_vikos" + version = "0.1.0" + authors = ["Klein, Markus "] + + [dependencies] + vikos = "0.1.6" + ``` +4. You can now start replacing code in `main.rs` with code from the [tutorial]. + + Documentation ------------- @@ -35,7 +57,7 @@ Want to help out? Just create an issue, pull request or contact markus.klein@blu [docs.rs]: https://docs.rs [documentation]: https://docs.rs/vikos/ -[tutorial]: https://docs.rs/vikos/0.1.4/vikos/tutorial/index.html +[tutorial]: https://docs.rs/vikos/0.1.6/vikos/tutorial/index.html [rustup]: http://www.rustup.rs [rustlearn]: https://github.com/maciejkula/rustlearn [leaf]: https://github.com/autumnai/leaf