Commit Graph

8 Commits

Author SHA1 Message Date
Travis Cross 81b8df4323 Add `rust-toolchain.toml` and revise README
We spent a lot of text in the README describing how to use the nightly
Rust compiler with this project.  Let's instead add a
`rust-toolchain.toml` file so that the nightly compiler is used
automatically, and let's redraft the README in that light.

With this revision, we'll add a section on installing dependencies in
which we'll describe how to ensure that the nightly compiler is
installed and up to date and how to install `mdbook`.

When describing how to clone the project, we'll suggest that people
clone the URL ending in `.git`.  This is what GitHub recommends, and
it removes a level of redirection which sometimes matters.

For people who want to download a ZIP file rather than using `git`,
we'll provide a direct link rather than simply referencing the GitHub
page.

When describing how to build the book, we'll suggesting passing
`--open` to `mdbook`, as this is usually what people will want, and it
will save a step.

Along with these changes, we include some general copyediting.
2024-02-19 07:03:53 +00:00
Travis Cross 1a23297a23 Cleanup wrapping, whitespace, etc. in `README.md`
In `README.md`, some lines were hard wrapped where others were not,
there was some trailing whitespace, and some list items were
terminated with a period where some were not.  Let's clean these
things up by hard wrapping all lines, cleaning up the whitespace, and
terminating all list items with periods.
2024-02-19 06:00:14 +00:00
Samuel Bronson 94af6e57ec
README.md: link to mdbook docs
Makes things easier for would-be contributors,
though sometimes it might just tell them that
mdbook doesn't support what they wanted to do.
2021-12-13 18:28:46 -05:00
saki-osive b0b1014599 Added setting nightly as a requirement for running tests 2021-01-27 22:49:34 +05:30
saki-osive b2ac3c1124 Refactored build steps for better readability 2021-01-17 21:30:02 +05:30
ximon18 acc8f54299
Update README.md
The `mdbook build` default output directory is `book`, not `docs`.
2020-08-03 09:35:05 +02:00
Miller e3cbdc87e8
changed bash to sh 2020-06-02 21:43:00 +06:00
Bráulio Bezerra 857c457e1b Added basic README.md with build instructions 2017-07-15 13:38:22 -03:00