Skip to content

Commit

Permalink
fix: reformat build prereqs in readme (#290)
Browse files Browse the repository at this point in the history
## Description:
Was setting up the pre-reqs to build Kurtosis locally to test a #219 but
noticed the formatting was off and hard to consume. This PR makes those
instructions easier to read and follow.

## Is this change user facing?
YES
<!-- If yes, please add the "user facing" label to the PR -->
<!-- If yes, don't forget to include docs changes where relevant -->

## References (if applicable):
<!-- Add relevant Github Issues, Discord threads, or other helpful
information. -->
  • Loading branch information
leeederek committed Mar 25, 2023
1 parent 4720da3 commit c286151
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Expand Up @@ -159,7 +159,7 @@ This repository is structured as a monorepo, containing the following projects:

To build Kurtosis, you must the following dependencies installed:

- Bash (5 or above) + Git
#### Bash (5 or above) + Git

On MacOS:
```bash
Expand All @@ -172,28 +172,28 @@ chsh -s "${BREW_PREFIX}/bin/bash"
# Install modern version of git, the one that ships on MacOS is too old
brew install git
```
- Docker
#### Docker

On MacOS:
```bash
brew install docker
```

- Go (1.18 or above)
#### Go (1.18 or above)

On MacOS:
```bash
brew install go@1.18
```

- Goreleaser
#### Goreleaser

On MacOS:
```bash
brew install goreleaser/tap/goreleaser
```

- Node (16.14 or above) and Yarn
#### Node (16.14 or above) and Yarn

On MacOS, using `NVM`:
```bash
Expand All @@ -202,7 +202,7 @@ mkdir ~/.nvm
nvm install 16.14.0
npm install -g yarn
```
- Go and Typescript protobuf compiler binaries
#### Go and Typescript protobuf compiler binaries

On MacOS:
```bash
Expand All @@ -212,7 +212,7 @@ brew install protoc-gen-grpc-web
npm install -g ts-protoc-gen
npm install -g grpc-tools
```
- Musl
#### Musl

On MacOS:
```bash
Expand Down

0 comments on commit c286151

Please sign in to comment.