diff options
| author | delet0r <lucas@humfeldt.de> | 2018-11-26 12:27:14 +0100 |
|---|---|---|
| committer | delet0r <lucas@humfeldt.de> | 2018-11-26 12:27:14 +0100 |
| commit | c5c32f4add2654f18aff5d9b6d5cf62d8fa47048 (patch) | |
| tree | 666c8581c4df2632b412ebde0bb129934a74cec9 /README.md | |
| parent | e0ee5f1d7fd706705f169074356280ea8b245d69 (diff) | |
README for CLI only version
This README mentions READMEs for every
exercise topic, those haven't been added yet.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 22 insertions, 1 deletions
@@ -1,3 +1,24 @@ # rustlings -A cool thing that is currently in development. +Greetings and welcome to rustlings. This project contains small exercises get you used to reading and writing code. This includes reading and responding to compiler messages! + +## How to get started +To use rustlings you have to have [rust](https://www.rust-lang.org/) installed on your machine. +If you already have it, you can clone the repo to your local environment with: +``` bash +git clone https://github.com/rustlings/rustlings.git +``` +To run rustlings you can either use `cargo run <subcommand>` or you can install rustlings on your machine +by running `cargo install --path <path to the rustlings repo>` +(NOTE: for rustling to function you have to be in the directory of the repo). + +## Doing exercises +The execises are sorted by topic and can be found in the subdirectory `rustlings/exercises/<topic>`. For every topic there is an additional README file with some reasources to get you started on the topic. We really recommend, that you have a look at them before you start. + +Your task is simple every exercise contains an error you have to solve, in order to make it compile. + +Running rustlings with the subcommand `verify` will compile every exercise in the recommended order. It will stop at the first exercise that didn't compile and show you the error to be solved. + +If you want to run a single erxercise you can use the subcommand `run <path to the exercise>`. + +When you struggle to solve the error, there is usually a tip at the bottom of the each exercise.
\ No newline at end of file |
