From 3ce3f1adc1f43a4f1632ff77c7caddc8c158afee Mon Sep 17 00:00:00 2001 From: Greg Fitzgerald Date: Thu, 13 Dec 2018 10:25:25 -0700 Subject: [PATCH] Move book dev instructions out of top-level readme --- README.md | 28 ---------------------------- book/README.md | 26 ++++++++++++++++++++++++++ 2 files changed, 26 insertions(+), 28 deletions(-) create mode 100644 book/README.md diff --git a/README.md b/README.md index c977e1e0e3..c694330170 100644 --- a/README.md +++ b/README.md @@ -61,34 +61,6 @@ $ git clone https://github.com/solana-labs/solana.git $ cd solana ``` -Building the Solana book ---- - -Install mdbook: - -```bash -cargo install mdbook -``` - -Run any Rust tests in the markdown: - -```bash -make -C book test -``` - -Render markdown as HTML: - -```bash -make -C book build -``` - -Render and view the book: - -```bash -make -C book open -``` - - Testing --- diff --git a/book/README.md b/book/README.md new file mode 100644 index 0000000000..44ac624950 --- /dev/null +++ b/book/README.md @@ -0,0 +1,26 @@ +Building the Solana book +--- + +Install mdbook: + +```bash +cargo install mdbook +``` + +Run any Rust tests in the markdown: + +```bash +make test +``` + +Render markdown as HTML: + +```bash +make build +``` + +Render and view the book: + +```bash +make open +```