├── README.md ├── basic-syntax.html ├── getting-started.html ├── index.html ├── strings.html ├── styles.css └── template.html /README.md: -------------------------------------------------------------------------------- 1 | # Rust in Ten Slides 2 | 3 | This is an experiment to produce short, useful documentation for the Rust 4 | programming language. 5 | 6 | Here's the idea: take a concept in Rust, and make ten slides about it. Ten 7 | slides is short enough to be easy to make and easy to consume, but long 8 | enough to get some kind of point across. 9 | 10 | If this is successful, I'd like to upstream it into the main Rust docs. 11 | 12 | This project is inspired by [A very brief intro to 13 | Rust](https://github.com/ashleygwilliams/a-very-brief-intro-to-rust). After 14 | seeing students write code after only looking at these slides, I think 15 | expanding on this idea might bear some interesting fruit! 16 | 17 | ## How it works 18 | 19 | 1. Copy `template.html` into a new file, name it after the topic of your 20 | presentation; for example, `strings.html`. 21 | 2. Slides are written in Markdown inside the file using [Remark](https://remarkjs.com/#1), 22 | check that link for examples of the syntax. 23 | 3. Open the file in your web browser to see the presentation in action! 24 | 4. Modify `index.html` to include your new presentation. 25 | 5. Send me a pull request! 26 | 27 | ## License 28 | 29 | Everything is licensed under MIT/Apache2, just like Rust. -------------------------------------------------------------------------------- /basic-syntax.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |
4 |This is an experiment to produce short, useful documentation for the Rust 28 | programming language.
29 | 30 |Here's the idea: take a concept in Rust, and make ten slides about it. Ten 31 | slides is short enough to be easy to make and easy to consume, but long 32 | enough to get some kind of point across.
33 | 34 |If this is successful, I'd like to upstream it into the main Rust docs.
35 | 36 |Here's what I've got so far:
37 | 38 |If you'd like to contribute some slides, please check this out on GitHub.
45 | 46 | 47 | 48 | -------------------------------------------------------------------------------- /strings.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |