Skip to content

Commit

Permalink
test push
Browse files Browse the repository at this point in the history
  • Loading branch information
itsdevbear committed Nov 28, 2023
1 parent 6357974 commit a308855
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit a308855

Please sign in to comment.