Skip to content

Commit 569bb82

Browse files
authored
Merge pull request #228 from ehuss/git-link
Add git link to the source.
2 parents 61d907d + 31a3eeb commit 569bb82

File tree

2 files changed

+10
-24
lines changed

2 files changed

+10
-24
lines changed

README.md

+7-24
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ You can also build the book and read it locally if you'd like.
1717

1818
### Requirements
1919

20-
Building the book requires [mdBook] 0.2. To get it:
20+
Building the book requires [mdBook] 0.4. To get it:
2121

22-
[mdBook]: https://github.com/azerupi/mdBook
22+
[mdBook]: https://github.com/rust-lang/mdBook
2323

2424
```bash
2525
$ cargo install mdbook
@@ -29,30 +29,13 @@ $ cargo install mdbook
2929

3030
The most straight-forward way to build and view the book locally is to use the following command:
3131
```bash
32-
$ mdbook serve
32+
$ mdbook serve --open
3333
```
3434

35-
This serves the book at http://localhost:3000, and rebuilds it on changes.
36-
You can now view the book in your web browser. If you make changes to the book's source code,
37-
you should only need to refresh your browser to see them.
38-
39-
_Firefox:_
40-
41-
```shell
42-
$ firefox http://localhost:3000 # Linux
43-
$ open -a "Firefox" http://localhost:3000 # OS X
44-
$ Start-Process "firefox.exe" http://localhost:3000 # Windows (PowerShell)
45-
$ start firefox.exe http://localhost:3000 # Windows (Cmd)
46-
```
47-
48-
_Chrome:_
49-
50-
```shell
51-
$ google-chrome http://localhost:3000 # Linux
52-
$ open -a "Google Chrome" http://localhost:3000 # OS X
53-
$ Start-Process "chrome.exe" http://localhost:3000 # Windows (PowerShell)
54-
$ start chrome.exe http://localhost:3000 # Windows (Cmd)
55-
```
35+
This builds the HTML version of the book, starts a webserver at
36+
http://localhost:3000, and opens your default web browser. It will also
37+
automatically rebuild the book whenever the source changes, and the page
38+
should automatically reload.
5639

5740
To run the tests:
5841

book.toml

+3
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,6 @@ authors = ["The Rust Project Developers"]
33
multilingual = false
44
src = "src"
55
title = "The Edition Guide"
6+
7+
[output.html]
8+
git-repository-url = "https://github.com/rust-lang/edition-guide"

0 commit comments

Comments
 (0)