From c5c32f4add2654f18aff5d9b6d5cf62d8fa47048 Mon Sep 17 00:00:00 2001 From: delet0r Date: Mon, 26 Nov 2018 12:27:14 +0100 Subject: [PATCH] README for CLI only version This README mentions READMEs for every exercise topic, those haven't been added yet. --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8049c22b..dfd48f67 100644 --- a/README.md +++ b/README.md @@ -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 ` or you can install rustlings on your machine +by running `cargo install --path ` +(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/`. 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 `. + +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