Skip to content

Update local setup docs #450

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
hunchr merged 1 commit into from
May 20, 2026
+3 −2
Merged

Update local setup docs #450

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,11 @@ Thank you for your work and have fun! :tada:

## Serving the Documentation Locally

To view this documentation on your machine, run the following command:
To view this documentation on your machine, run the following commands:

```sh
mbook serve
brew install mdbook
Copy link
Copy Markdown
Contributor

@cb341 cb341 May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
brew install mdbook

Copy link
Copy Markdown
Member Author

@hunchr hunchr May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not everyone has cargo installed and knows how to use it, or update it.

mdbook serve
```

## License
Expand Down
Loading