diff --git a/Makefile b/Makefile index 1a8989c..4db2886 100644 --- a/Makefile +++ b/Makefile @@ -10,6 +10,10 @@ all: fmt build build: @mdbook build +## This target serves the book locally +serve: + @mdbook serve + ## This target will setup the necessary tools for the project setup: @rustup component add rustfmt diff --git a/README.md b/README.md index f059d2c..12d3156 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,21 @@ This is the source code for the SWE Guidelines book, an open-source guide our software engineering best practices. This guide is a work in progress and we welcome contributions. If you have suggestions or improvements, please submit a pull request. - ## Getting Started To build the book, you will need to have mdBook installed. If you don't have it, you can install it with: ```bash -cargo install mdbook +make setup ``` Then you can serve the book on `http://localhost:3000`: ```bash -mdbook serve +make serve +``` + +## Formatting + +You can format all of the markdown files in this repo using: +```bash +make fmt ```