Skip to content

Add git link to the source. #228

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

Merged
merged 2 commits into from
Feb 17, 2021
Merged

Add git link to the source. #228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e22f5f
Add git link to the source.
ehuss Dec 26, 2020
31a3eeb
Update building instructions.
ehuss Dec 26, 2020
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
31 changes: 7 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ You can also build the book and read it locally if you'd like.

### Requirements

Building the book requires [mdBook] 0.2. To get it:
Building the book requires [mdBook] 0.4. To get it:

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

```bash
$ cargo install mdbook
Expand All @@ -29,30 +29,13 @@ $ cargo install mdbook

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

This serves the book at http://localhost:3000, and rebuilds it on changes.
You can now view the book in your web browser. If you make changes to the book's source code,
you should only need to refresh your browser to see them.

_Firefox:_

```shell
$ firefox http://localhost:3000 # Linux
$ open -a "Firefox" http://localhost:3000 # OS X
$ Start-Process "firefox.exe" http://localhost:3000 # Windows (PowerShell)
$ start firefox.exe http://localhost:3000 # Windows (Cmd)
```

_Chrome:_

```shell
$ google-chrome http://localhost:3000 # Linux
$ open -a "Google Chrome" http://localhost:3000 # OS X
$ Start-Process "chrome.exe" http://localhost:3000 # Windows (PowerShell)
$ start chrome.exe http://localhost:3000 # Windows (Cmd)
```
This builds the HTML version of the book, starts a webserver at
http://localhost:3000, and opens your default web browser. It will also
automatically rebuild the book whenever the source changes, and the page
should automatically reload.

To run the tests:

Expand Down
3 changes: 3 additions & 0 deletions book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ authors = ["The Rust Project Developers"]
multilingual = false
src = "src"
title = "The Edition Guide"

[output.html]
git-repository-url = "https://github.com/rust-lang/edition-guide"