Skip to content

Commit

Permalink
chore: Add a docs section about mise
Browse files Browse the repository at this point in the history
  • Loading branch information
janjakubnanista committed Jan 27, 2025
1 parent ab0b509 commit fd93ffe
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -609,6 +609,32 @@ kurtosis service stop <enclave-name> <service-name>
kurtosis service start <enclave-name> <service-name>
```

## Development

### Development environment

We use [`mise`](https://mise.jdx.dev/) as a dependency manager for these tools.
Once properly installed, `mise` will provide the correct versions for each tool. `mise` does not
replace any other installations of these binaries and will only serve these binaries when you are
working inside of the `optimism-package` directory.

#### Install `mise`

Install `mise` by following the instructions provided on the
[Getting Started page](https://mise.jdx.dev/getting-started.html#_1-install-mise-cli).

#### Install dependencies

```sh
mise install
```

### Testing

We use [`BATS`](https://bats-core.readthedocs.io/en/stable/index.html), _Bash Automated Testing System_ to write tests for this repository.

`BATS` is installed as a git submodule so make sure to clone the repo with submodules if you want to run the test suite.

## Contributing

If you have made changes and would like to submit a PR, test locally and make sure to run `lint` on your changes
Expand Down

0 comments on commit fd93ffe

Please sign in to comment.