Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove $ prefix from bash code blocks for improved copy-pasting exper… #4108

Closed
wants to merge 1 commit into from
Closed

Remove $ prefix from bash code blocks for improved copy-pasting exper… #4108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ rust-lang/rust uses in [this file][rust-mdbook]. To get it:
[rust-mdbook]: https://github.com/rust-lang/rust/blob/master/src/tools/rustbook/Cargo.toml

```bash
$ cargo install mdbook --locked --version <version_num>
cargo install mdbook --locked --version <version_num>
```

The book also uses two mdbook plugins which are part of this repository. If you
Expand All @@ -39,42 +39,42 @@ look right, but you *will* still be able to build the book. To use the plugins,
you should run:

```bash
$ cargo install --locked --path packages/mdbook-trpl-listing
$ cargo install --locked --path packages/mdbook-trpl-note
cargo install --locked --path packages/mdbook-trpl-listing
cargo install --locked --path packages/mdbook-trpl-note
```

## Building

To build the book, type:

```bash
$ mdbook build
mdbook build
```

The output will be in the `book` subdirectory. To check it out, open it in
your web browser.

_Firefox:_
```bash
$ firefox book/index.html # Linux
$ open -a "Firefox" book/index.html # OS X
$ Start-Process "firefox.exe" .\book\index.html # Windows (PowerShell)
$ start firefox.exe .\book\index.html # Windows (Cmd)
firefox book/index.html # Linux
open -a "Firefox" book/index.html # OS X
Start-Process "firefox.exe" .\book\index.html # Windows (PowerShell)
start firefox.exe .\book\index.html # Windows (Cmd)
```

_Chrome:_
```bash
$ google-chrome book/index.html # Linux
$ open -a "Google Chrome" book/index.html # OS X
$ Start-Process "chrome.exe" .\book\index.html # Windows (PowerShell)
$ start chrome.exe .\book\index.html # Windows (Cmd)
google-chrome book/index.html # Linux
open -a "Google Chrome" book/index.html # OS X
Start-Process "chrome.exe" .\book\index.html # Windows (PowerShell)
start chrome.exe .\book\index.html # Windows (Cmd)
```

To run the tests:

```bash
$ cd packages/trpl
$ mdbook test --library-path packages/trpl/target/debug/deps
cd packages/trpl
mdbook test --library-path packages/trpl/target/debug/deps
```

## Contributing
Expand Down