https://github.com/steveklabnik/rust-in-ten-slides

Short presentations about Rust syntax + concepts
https://github.com/steveklabnik/rust-in-ten-slides

documentation learning rust

Last synced: 12 days ago
JSON representation

Short presentations about Rust syntax + concepts

• Host: GitHub
• URL: https://github.com/steveklabnik/rust-in-ten-slides
• Owner: steveklabnik
• Archived: true
• Created: 2018-04-04T14:30:06.000Z (over 6 years ago)
• Default Branch: gh-pages
• Last Pushed: 2021-01-11T18:07:20.000Z (almost 4 years ago)
• Last Synced: 2024-08-01T22:53:33.043Z (3 months ago)
• Topics: documentation, learning, rust
• Language: HTML
• Homepage: https://steveklabnik.github.io/rust-in-ten-slides/
• Size: 30.3 KB
• Stars: 72
• Watchers: 8
• Forks: 6
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Rust in Ten Slides

This is an experiment to produce short, useful documentation for the Rust

programming language.

Here's the idea: take a concept in Rust, and make ten slides about it. Ten

slides is short enough to be easy to make and easy to consume, but long

enough to get some kind of point across.

If this is successful, I'd like to upstream it into the main Rust docs.

This project is inspired by [A very brief intro to

Rust](https://github.com/ashleygwilliams/a-very-brief-intro-to-rust). After

seeing students write code after only looking at these slides, I think

expanding on this idea might bear some interesting fruit!

## How it works

1. Copy `template.html` into a new file, name it after the topic of your

   presentation; for example, `strings.html`.

2. Slides are written in Markdown inside the file using [Remark](https://remarkjs.com/#1),

   check that link for examples of the syntax.

3. Open the file in your web browser to see the presentation in action!

4. Modify `index.html` to include your new presentation.

5. Send me a pull request!

## License

Everything is licensed under MIT/Apache2, just like Rust.