Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contents and local dev instructions to README #69

Merged
merged 1 commit into from
Jan 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,35 @@ trust risks erosion.
This repository serves as a home for the working group to design
a standard debugging data format for smart contracts on
Ethereum-compatible networks.

## Contents

This repository contains a
[`schemas/`](https://github.com/ethdebug/format/tree/main/schemas) directory
with the formal JSON Schemas defined by this project (in YAML format).

This repository also contains a number of NPM packages (currently unpublished):
- **@ethdebug/format**: A Node.js-compatible distribution of these schemas
- **@ethdebug/format-tests**: Contains a test suite for validating schemas and
testing examples/other constraints.
- **@ethdebug/format-web**: The docusaurus site source that powers this
project's homepage.

## Developing locally

To build and run the site locally, please ensure you have Node.js
(LTS or better) and `yarn` installed globally.

First, clone this repo and install the Node.js dependencies:
```console
git clone https://github.com/ethdebug/format.git
cd format
yarn
```

Then, run this command to start a watcher process which rebuilds and reloads
on any changes. This will open your browser to `http://localhost:3000/format`:

```console
yarn start
```