Skip to content

Commit

Permalink
merge correct readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sarahsonder authored May 23, 2024
1 parent eb59378 commit 27a2e9e
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ m.save("simple_demo.svg");

produces a file `simple_demo.svg` that looks like the following:

![Sample usage svg output](../docs/docs/99-api/examples/simple_demo/simple_demo.svg)
![Sample usage svg output](docs/docs/99-api/examples/simple_demo/simple_demo.svg)

For more information, check out the project [documentation website](https://www.cs.toronto.edu/~david/memory-viz/) and [demo](https://www.cs.toronto.edu/~david/memory-viz/demo/).

Expand Down Expand Up @@ -98,3 +98,23 @@ To run the test suite, execute the following command:
```console
$ npm run test --workspace=memory-viz
```

### Building and running the documentation website

See [`docs/README.md`](docs/README.md).

### Building and running the demo website

1. First, build the assets using Webpack:

```console
$ npm run build-dev --workspace=memory-viz-demo
```

2. Then run the website:

```console
$ npm run start --workspace=memory-viz-demo
```

3. Visit the website at `http://localhost:9000`.

0 comments on commit 27a2e9e

Please sign in to comment.