Skip to content

Commit

Permalink
Add note that none of this came from ChatGPT.
Browse files Browse the repository at this point in the history
  • Loading branch information
jwalton committed Apr 25, 2023
1 parent e7c9cee commit c753564
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/ch00-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,20 @@ hide_title: true

This is an abridged - or perhaps a better word would be condensed - version of ["The Rust Programming Language"](https://doc.rust-lang.org/stable/book/title-page.html) (AKA "the Rust Book"). This is not an original work - all the chapter names and examples in this book have been copied verbatim from the original, but all of the prose has been rewritten from scratch, leaving out anything that's not about learning Rust. This book is about 1/2 the length of the original, but I don't think it is missing anything that an experienced software developer wouldn't already know.

The Rust Book is a great resource for learning Rust, especially if you're new to programming. If you fall into this category, then I strongly suggest you put this book down and go read it instead. But... the Rust Book is a bit wordy. If you're already familiar with one or more other programming languages, then you are likely already familiar with a lot of the concepts the book covers, and you might benefit from this shorter version. If you are already familiar with ideas like the stack and the heap, with test driven development, with the [DRY principal](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself), then this might be a better read.
The Rust Book is a great resource for learning Rust, especially if you're new to programming. If you fall into this category, then I strongly suggest you put this book down and go read it instead. But... the Rust Book is quite wordy. If you're already familiar with one or more other programming languages, then you are likely already familiar with a lot of the concepts the book covers, and you might benefit from this shorter version. If you are already familiar with ideas like the stack and the heap, with test driven development, with the [DRY principal](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself), then this might be a better read.

This isn't meant to be a criticism of the Rust Book. It's excellent and well written, and there's a reason why it's highly recommended. The problem here is not with the original book, but more a mismatch when it comes to intended audience.

## What's different about this book?

As mentioned above, the chapter names in this book are all the same as in the original, and in many cases the subsections in each chapter are the same. In most cases examples have been copied directly from the original. Keeping the original structure and examples hopefully makes it easy to jump back and forth between this book and the original, in case there are places where this book is unclear or covers concepts you are not familiar with.

Where the original would build up a code example piece by piece, in most cases this version presents the finished code so you can read through it, and then points out some interesting parts. Where possible I've tried to add in material I think an advanced reader would find interesting. In places where I found the original book confusing I've tried to explain things in a different way.

This also adds an extra bonus chapter about async programming!
Where the original would build up a code example piece by piece, in most cases this version presents the finished code so you can read through it, and then points out some interesting parts. Where possible I've tried to add in material I think an advanced reader would find interesting. In some places this explains things in a different way than the original. This also adds an extra bonus chapter about async programming!

I have a great deal of experience in TypeScript, Java, C/C++, Go, and a few other languages. I spent about two weeks putting this book together, reading the original, condensing it, and researching parts that weren't clear. Hopefully someone finds this useful! But I am a new to Rust so if you find something that doesn't make sense, please feel free to [raise an issue](https://github.com/jwalton/rust-book-abridged).

This book was written entirely by a human - none of this is generated by ChatGPT.

If you enjoy this book, please [give it a star on GitHub](https://github.com/jwalton/rust-book-abridged).

## Table of Contents
Expand Down

0 comments on commit c753564

Please sign in to comment.