From 9d7d78c22853bb8d821b3f30a178f905b340c2ce Mon Sep 17 00:00:00 2001 From: Seth Niimi Date: Sat, 15 Dec 2018 21:58:19 -0800 Subject: [PATCH] Anchor internal links to the root of the book & Update README.md --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 8643dbb6..d2f59db4 100644 --- a/README.md +++ b/README.md @@ -29,31 +29,31 @@ $ cargo install mdbook ### Building -To build the book, do this: - +The most straight-forward way to build and view the book locally is to use the following command: ```bash -$ mdbook build +$ mdbook serve ``` -The output will be in the `book` subdirectory. To check it out, open it in -your web browser. +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 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 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 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 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) ``` To run the tests: