Skip to content

Commit

Permalink
readme: document previews
Browse files Browse the repository at this point in the history
Signed-off-by: William Casarin <[email protected]>
  • Loading branch information
jb55 committed Apr 20, 2024
1 parent 05fe164 commit bf77754
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,32 @@ The app should appear on the emulator
[direnv]: https://direnv.net/
[nix]: https://nixos.org/download/

## Previews

You can preview individual widgets and views by running the preview script:

```bash
./preview RelayView
./preview ProfilePreview
# ... etc
```

When adding new previews you need to implement the Preview trait for your
view/widget and then add it to the `src/ui_preview/main.rs` bin:

```rust
previews!(runner, name,
RelayView,
AccountLoginView,
ProfilePreview,
);
```


## Contributing

Configure the developer environment:

```bash
./scripts/dev_setup.sh
```
Expand Down

0 comments on commit bf77754

Please sign in to comment.