Skip to content

Commit

Permalink
Add documentation for local development (#130)
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinweaver authored Jun 11, 2024
1 parent 5b72fc6 commit bfdc39e
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,26 @@ npm install -g @0xmetropolis/metal
yarn global add @0xmetropolis/metal
```

## Development

The first time you set up metal for local development, you will need to run a setup script via:

```bash
yarn run dev
```

Whenever adding new features to metal, it can be helpful to auto-recompile the app:

```bash
yarn watch
```

In a new terminal, you can then issue commands to your local metal repo with the mdev command:

```bash
mdev help
```

# Usage

## Generate A Preview
Expand Down

0 comments on commit bfdc39e

Please sign in to comment.