Skip to content

Commit bdb4d1a

Browse files
committed
docco updates
1 parent 568492d commit bdb4d1a

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,28 @@
22

33
One of the first things I like to do after gaining some familiarity with a language is a couple of katas, maybe Blackjack, an API of some sort. All test driven of course. Thats what we'll do here.
44

5-
What I find sorely missing in education is hierarchy of importances. Most resources give you every single bit of data related to a subject with equal stress. For example, with a written language a hierarchy of inportances would be:
5+
What I find sorely missing in education is hierarchy of knowledge. Most resources give you every single bit of data related to a subject with equal stress. For example, with a written language a hierarchy of knowledge would be:
66

77
- alphabet
88
- words
99
- grammar
1010
- structure
1111

12-
So, for a new language I first learn the alphabet (operators), words (reserved words), grammar (syntax), structure (files, modules, tests).
12+
So, for a new language I first learn the alphabet (operators), words (reserved words), grammar (syntax), structure (files, modules, tests). The things usually used 80% of the time should be **emphasized** whereas edge cases would probably be an aside or in an appendix.
1313

1414
## Definitions
1515

1616
Rust is a [system language](https://en.wikipedia.org/wiki/System_programming_language), meaning it can be used for low level stuff such as Operating Systems, hardware and the like. That doesn't mean it is limited to those however.
1717

18-
Why Rust? Type safety, concurrency, blazingly fast. Rust has a steep learning curve however.
18+
Why Rust? What makes Rust great?:
19+
20+
- high level language with low level capabilities
21+
- strongly typed
22+
- no garbage collector, instead tracking it itself
23+
- concurrency built in
24+
- blazingly fast (because of the above)
25+
26+
Rust has a steep learning curve however.
1927

2028
## Style
2129

@@ -24,7 +32,7 @@ Rust has an opinionated coding style:
2432
- indentations are 4 spaces
2533
- variable names are snake case
2634

27-
But, before fundamentals, lets talk about the build runner, documentation generator, test runner and package manager - Cargo.
35+
But, before the Rust fundamentals, lets talk about the build runner, documentation generator, test runner and package manager - Cargo.
2836

2937
## Cargo
3038

@@ -52,7 +60,7 @@ version = "0.1.0"
5260
authors = ["Your Name <[email protected]>"]
5361
edition = "2018"
5462

55-
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
63+
### See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
5664

5765
[dependencies]
5866
```
@@ -65,7 +73,7 @@ fn main() {
6573
}
6674
```
6775

68-
First things first, the Cargo.toml file. This is the configuration file for your software. This has all the information about your project, the name, authors, version (semver), project name (used when imporiting files) etc. It is also where you add your dependencies.
76+
First things first, the Cargo.toml file. This is the configuration file for your software. This has all the information about your project, the name, authors, version (semver), project name (used when importing files) etc. It is also where other package dependencies are imported.
6977

7078
The rust file that is generated is a 'hello world' by default.
7179

@@ -349,7 +357,7 @@ fn main() {
349357

350358
## References
351359

352-
- [CleanCut Rust corse](https://github.com/CleanCut/rust_programming/)
360+
- [CleanCut Rust course](https://github.com/CleanCut/rust_programming/)
353361
- [Rust loops](https://doc.rust-lang.org/1.6.0/book/loops.html)
354362
- [Modules](https://doc.rust-lang.org/book/ch07-02-defining-modules-to-control-scope-and-privacy.html)
355363
- [Rust unit test](https://doc.rust-lang.org/book/ch11-03-test-organization.html)

0 commit comments

Comments
 (0)