Commit Graph

65 Commits

Author SHA1 Message Date
Chris Krycho 8f201a99c6
Merge pull request #3656 from arjun051/patch-1
Update README.md
2024-04-03 13:29:42 -06:00
Chris Krycho 54d5a35dfb
Revert extraneous comma 2024-04-03 13:27:16 -06:00
Jonah Nestrick 42a052a685 Update README to use --locked for installing mdbook 2024-01-29 13:36:04 -05:00
Marcus Stollsteimer d0473bee36 Fix mdBook links 2023-11-09 09:49:16 -05:00
Arjun Aggarwal a125fc772c
Update README.md
->It appears that you are missing a comma after the introductory 
    phrase ideally
->The noun phrase word seems to be missing a determiner 
     before it
2023-05-21 03:12:39 +05:30
printfn 4404cbcc35 Fix broken nostarch URL 2023-01-23 10:15:22 -05:00
Timothy Odebunmi a60f4316ec Fix Install MdBook command
The command to install mdbook specified the version the wrong way and it failed on zsh
2022-11-16 10:07:18 -05:00
Kurt Kremitzki 578591a3db Update book repo links for default branch rename 2021-12-02 21:16:17 -05:00
Carol (Nichols || Goulding) a07036f864
Set expectations a bit more realistically 2021-07-26 20:19:46 -04:00
Carol (Nichols || Goulding) bf33eb6289
Fix word wrapping, mention dictionary.txt is also in the ci dir 2021-03-19 10:08:48 -04:00
Riccardo Magliocchetti e05db66dfd
README: note that spellcheck.sh is in ci directory 2021-03-17 08:59:39 +01:00
Carol (Nichols || Goulding) 493f717003
Remove the version number entirely so we can stop updating it 2020-07-27 15:29:25 -04:00
Tomaz Canabrava 7867b8d01e mdbook version used is now 0.4.x 2020-07-27 17:56:09 +02:00
Steve Klabnik 201e91019d Fix CI status in README
It's the name of the workflow, not the name of the file the workflow is
in. D'oh!
2020-05-22 23:41:05 -05:00
Steve Klabnik 4a49a4b7d9 Port to GitHub Actions
Most of the Rust project has moved over to Actions, but we were still on
Travis. This sets up the needed Actions for us.
2020-05-22 23:36:19 -05:00
Carol (Nichols || Goulding) 7945e1008c
Document administrative tasks that are now scripted 2020-01-24 09:09:16 -05:00
Carol (Nichols || Goulding) c13f3512a7
Document that the code listings are available on the releases tab 2020-01-10 15:04:49 -05:00
Tobias Pfeiffer 71fc588d9f
Update loose mdbook version reference 2019-06-24 11:55:31 +02:00
mikong 3d64422e4c
Update mdbook links 2019-06-16 13:03:44 +08:00
Carol (Nichols || Goulding) 0d7e6c52af
Update the version of mdbook we use in-tree to match rust-lang/rust
As of the merging of https://github.com/rust-lang/rust/pull/59876, TRPL
is using mdbook 2!
2019-04-12 09:05:21 -04:00
lwshang 82093d572f Fix Travis CI badge url 2019-04-05 16:50:53 -04:00
Chirag Jain 705cdc1c58
Fix mdbook link text in readme
I found reading that big link a bit weird, feel free to reject the PR 😄
2019-03-24 01:15:46 +05:30
Carol (Nichols || Goulding) c4795c3358
Update some details in the README 2019-01-05 20:11:01 -05:00
Steve Klabnik dc5dae5789 Fix up contribution instructions
now longer that we no longer ship all of the older books.
2018-12-12 09:59:58 -05:00
Ralf Jung 7fcf50e414 update README to match issue template 2018-08-19 18:13:24 +02:00
Carl Gay 01627bd871 Simple typo in README.md 2018-05-26 17:36:44 -04:00
Carol (Nichols || Goulding) 2d2693f8df
Second edition is effectively done 2018-05-16 15:40:49 -04:00
steveklabnik 248579e8fe Update contributing information for 2018 edition 2018-04-05 12:43:05 -04:00
Carol (Nichols || Goulding) e132c78ec9
Update the README with latest status of print/online reading 2018-01-29 14:35:28 -05:00
Carol (Nichols || Goulding) 083fc511b9
Add a bigger notice about status of frozen columns
Just to be even more up front about what's happening.
2017-11-27 15:52:21 -05:00
Carol (Nichols || Goulding) dae3772383
Clarify the many different ways you could read online 2017-11-27 15:48:13 -05:00
Carol (Nichols || Goulding) 0d9d5e0c5a Specify that mdbook version should really match what rust-lang/rust is using 2017-10-26 12:32:51 -04:00
Carol (Nichols || Goulding) b574715a1b Remove unneeded square brackets 2017-03-27 10:35:19 -04:00
Carol (Nichols || Goulding) 02f2fbb854 Update contributing info 2017-03-26 11:38:00 -04:00
steveklabnik 979c56634f be explicit with the README
this means that rustdoc --test will now pass on it
2017-03-13 15:03:58 -04:00
Tom Kierzkowski ba298be61b Added additional steps to run the book from Windows powershell and command line 2017-03-11 14:42:01 -05:00
Carol (Nichols || Goulding) 2ef7a628b7 Mention that you now have to cd into an edition to build
Fixes #517.
2017-03-09 23:07:13 -05:00
Jo Liss 96fce1e17d Emphasize link to online version, de-emphasize link to original book 2017-03-02 14:38:49 +00:00
Adam Voss bfc5a65754 Automate normalization of line endings 2017-02-23 20:20:35 -06:00
Carol (Nichols || Goulding) c179138ae6 Add a heading 2017-02-18 21:49:24 -05:00
Carol (Nichols || Goulding) 57811c03bc Note translation efforts 2017-02-18 20:16:40 -05:00
Carol (Nichols || Goulding) 840cfc8e1c Clarify the readme a bit 2016-12-11 12:00:22 -05:00
Carol (Nichols || Goulding) d5aa0440f7 Merge remote-tracking branch 'origin/pr/338' into spell 2016-12-11 11:54:44 -05:00
Carol (Nichols || Goulding) 5d161de0ed Save the `tr` command I keep going to SO for 2016-12-05 11:06:38 -05:00
Boris Egorov 6999230788 Add spellchecker script and dictionary of valid words for it
Fixes #118
2016-12-02 00:54:51 +07:00
Carol (Nichols || Goulding) 3c38b59ab6 Replace all uses of bash syntax highlighting
Since none of these are actually bash scripts :)

Changed all the instances in the src files to text, which, since my PR
to mdbook got accepted, will still do code background colors but no
syntax highlighting.

Fixes #295 and #327.
2016-11-14 12:18:48 -05:00
Carol (Nichols || Goulding) a08e7fab8f Document the graphviz stuff for my own benefit
So that I don't have to look it up and figure out what I did to get them
to work the last time.
2016-11-10 17:59:12 -05:00
Carol (Nichols || Goulding) d199e608d8 Clarify that we likely won't change chapters that have gone to layout
Fixes #324.
2016-11-10 17:36:47 -05:00
Carol (Nichols || Goulding) 82f5928b89 Script unzipping too; add instructions to README 2016-10-15 11:51:29 -04:00
Patrick McCann 8ef9d1f2e4 Add Chrome/Linux bash command 2016-09-12 20:12:58 -04:00