Skip to content

Commit

Permalink
updated readme for releases.
Browse files Browse the repository at this point in the history
  • Loading branch information
finger563 committed Apr 10, 2017
1 parent 3ce06c3 commit 46a09f1
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,29 @@ an [Electron](https://electron.atom.io) app which
utilizes [Plotly.js](https://plot.ly) and regular expressions to parse the
*Component Logs* generated by ROSMOD components.

ROSMOD Plotter enables plotting logs directly from files recovered or
downloaded without needing to run the ROSMOD WebGME server.

To use ROSMOD Plotter navigate to
[Releases](https://github.com/rosmod/plotter/releases) and download
the latest release for your platform.

Usage:
1. Download and extract the zip according to the platform you're running
2. Go into the extracted folder and execute `ROSMOD Plotter`.
3. *Right Click* and select `Open Log`
4. Navigate to the log file you want to load.
5. Enjoy the plot (and repeat steps 3 and 4 for as many logs as you want to plot.

Controls:
* Hover over plot: shows closest point on closest plot
* Click + drag inside plot to zoom
* Double Click inside plot to reset zoom
* Click on legend item to hide it
* Double click on legend item to toggle showing only it and the previous selection
* Click on the title to toggle hiding the plot altogether
* Click on the camera icon (shown when hovering over the upper right corner of a plot) to download a png of the plot as it is shown in the app (size and current selections etc.).

## Installation

```bash
Expand Down

0 comments on commit 46a09f1

Please sign in to comment.