Skip to content

Commit

Permalink
Merge pull request #315 from visdesignlab/docs-readme-update
Browse files Browse the repository at this point in the history
Update readme to include documentation
  • Loading branch information
JakeWags authored Mar 19, 2024
2 parents c69e27f + 23b0ea6 commit 55df9a8
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ UpSet: Visualization of Intersecting Sets
IEEE Transactions on Visualization and Computer Graphics (InfoVis), 20(12): 1983--1992, doi:10.1109/TVCG.2014.2346248, 2014.
```

## Documentation

Developer documentation can be found at [https://vdl.sci.utah.edu/upset2/](https://vdl.sci.utah.edu/upset2/).

For more information on documentation see the [Developer Documentation Guidelines](#developer-documentation-guidelines).

## Local Installation

To deploy UpSet 2.0 locally it is necessary to install the Multinet infrastructure.
Expand Down Expand Up @@ -64,3 +70,9 @@ To open the test in a UI view to track steps, append `--ui`.
This will launch a local server if there is not one already running on port 3000.

To add a test, add a `.spec.ts` file to `e2e-tests`. For information on how to use playwright, please see the [playwright documentation](https://playwright.dev/docs/writing-tests).

## Developer Documentation Guidelines

When adding a new feature, ensure that your additions are well documented following [JSDoc style annotations](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html).

To build the documentation locally, use the command: `yarn doc`. The default file output is at `/docs`.

0 comments on commit 55df9a8

Please sign in to comment.