Skip to content

Commit

Permalink
docs: improve prerequisites for OSX users (#6157)
Browse files Browse the repository at this point in the history
* chore: added extra error logs when gdu is not installed

* chore: improves prerequisites for osx

* chore: fixed spelling

* chore: update list symbol

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

* chore: update quote type

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

* chore: fix lint issue

* chore: added extra words to wordlist

* chore: fixed wordlist order

* chore: fix wording

Co-authored-by: Matthew Keil <me@matthewkeil.com>

* chore: fix wording

Co-authored-by: Matthew Keil <me@matthewkeil.com>

* fix: revert linking to CONTRIBUTING for prerequisites

---------

Co-authored-by: Nico Flaig <nflaig@protonmail.com>
Co-authored-by: Matthew Keil <me@matthewkeil.com>
  • Loading branch information
3 people authored Dec 7, 2023
1 parent 6154029 commit 5270ef2
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 1 deletion.
1 change: 1 addition & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ config
configs
const
constantish
coreutils
cors
cryptographic
dApp
Expand Down
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ Thanks for your interest in contributing to Lodestar. It's people like you that
- :gear: [NodeJS](https://nodejs.org/) (LTS)
- :toolbox: [Yarn](https://yarnpkg.com/)

### MacOS Specifics

When using MacOS, there are a couple of extra prerequisites that are required.

- python
- coreutils (e.g. via `brew install coreutils`)

## Getting Started

- :gear: Run `yarn` to install dependencies.
Expand Down
3 changes: 2 additions & 1 deletion packages/db/test/unit/controller/level.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,8 @@ describe("LevelDB controller", () => {
return "gdu";
}
} catch {
/* no-op */
/* eslint-disable no-console */
console.error("Cannot find gdu command, falling back to du");
}
}
return "du";
Expand Down

0 comments on commit 5270ef2

Please sign in to comment.