Skip to content

Commit

Permalink
Fix links to webviz tool (#160)
Browse files Browse the repository at this point in the history
* Fix links to webviz tool
* Add a tiny bit more info on how to run Webviz locally  Per #161
  • Loading branch information
janpaul123 authored and jtbandes committed Jun 24, 2019
1 parent 9dde109 commit 9be1ffe
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

**Webviz** is a web-based application for playback and visualization of [ROS](http://www.ros.org/) [bag files](http://wiki.ros.org/Bags). This repository also contains some libraries that can be used independently to build web-based visualization tools.

- **webviz-core** ([homepage](https://webviz.io/webviz/), [github](https://github.com/cruise-automation/webviz/tree/master/packages/webviz-core)): A tool to inspect [ROS bags](http://wiki.ros.org/ROS/Tutorials/Recording%20and%20playing%20back%20data).
- **webviz-core** ([homepage](https://webviz.io/), [tool](https://webviz.io/try), [github](https://github.com/cruise-automation/webviz/tree/master/packages/webviz-core)): A tool to inspect [ROS bags](http://wiki.ros.org/ROS/Tutorials/Recording%20and%20playing%20back%20data).
- **regl-worldview** ([homepage](https://webviz.io/worldview/), [npm](https://www.npmjs.com/package/regl-worldview), [github](https://github.com/cruise-automation/webviz/tree/master/packages/regl-worldview)): React library for rendering 2D and 3D scenes using [regl](https://github.com/regl-project/regl).
- **react-key-listener** ([npm](https://www.npmjs.com/package/react-key-listener), [github](https://github.com/cruise-automation/webviz/tree/master/packages/react-key-listener)): React component for handling keyboard events, without interfering with editable fields and buttons.
- **@cruise-automation/hooks** ([npm](https://www.npmjs.com/package/@cruise-automation/hooks), [github](https://github.com/cruise-automation/webviz/tree/master/packages/@cruise-automation/hooks)): A list of resusable React hooks.
Expand All @@ -18,10 +18,10 @@ Please see the individual package READMEs for details on how to install and use
## Developing

- `npm run bootstrap` in the root directory to install dependencies.
- `npm run docs` to run the docs app (e.g. go to http://localhost:8080/try to open Webviz).
- `npm run build` to run a single build or `npm run watch` to watch and build.
- `npm run storybook` to run storybook.
- `npm run screenshot-debug` to generate screenshots from stories.
- `npm run docs` to run the docs app.
- `npm run lint` to run the linters (and `npm run lint:fix` to automatically fix issues).
- `npm run flow` to run Flow.
- `npm run flow-typed-rebuild` to update the flow-typed definitions (any time when changing packages).
Expand Down

0 comments on commit 9be1ffe

Please sign in to comment.