Skip to content

Commit

Permalink
docs(macos): brew bundle for dev deps on macos
Browse files Browse the repository at this point in the history
  • Loading branch information
klardotsh committed Feb 22, 2022
1 parent 99ca839 commit d585adb
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
7 changes: 7 additions & 0 deletions Brewfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# vim: ft=ruby
# ^ it's not Ruby, but it's a Ruby-based DSL so we're rolling with it

brew 'rustup'
brew 'scdoc'

cask 'docker'
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,20 @@ The source must pass `rustfmt` and `clippy` without errors. It _should_ also
pass without warnings, unless there's good reason to leave the warnings in
place.

MacOS users can use `brew bundle` to install the development dependencies as
found in `Brewfile` (note that this will install Docker Desktop via its Cask;
if you've installed Docker Desktop via some other means you may need to either
uninstall your existing copy, or remove this line from `Brewfile`. Take
care not to submit a PR with such a change in place!). Linux users should
install `rustup` and `scdoc` via their distribution package manager. If
`rustup` isn't available but a Rust of at least the MSRV is, then
system-wide Rust is fine.

If you've never worked with Rust before and `rustup` is freshly installed,
you'll need to run `rustup-init` to pull Cargo, the Rust toolchain, etc.

Tangentially to all of this, a `Dockerfile` is provided if preferred.

## Legal

(c) 2022 The Wanderlust Group, All Rights Reserved
Expand Down

0 comments on commit d585adb

Please sign in to comment.