Skip to content

Commit 46a09f1

Browse files
committed
updated readme for releases.
1 parent 3ce06c3 commit 46a09f1

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,29 @@ an [Electron](https://electron.atom.io) app which
55
utilizes [Plotly.js](https://plot.ly) and regular expressions to parse the
66
*Component Logs* generated by ROSMOD components.
77

8+
ROSMOD Plotter enables plotting logs directly from files recovered or
9+
downloaded without needing to run the ROSMOD WebGME server.
10+
11+
To use ROSMOD Plotter navigate to
12+
[Releases](https://github.com/rosmod/plotter/releases) and download
13+
the latest release for your platform.
14+
15+
Usage:
16+
1. Download and extract the zip according to the platform you're running
17+
2. Go into the extracted folder and execute `ROSMOD Plotter`.
18+
3. *Right Click* and select `Open Log`
19+
4. Navigate to the log file you want to load.
20+
5. Enjoy the plot (and repeat steps 3 and 4 for as many logs as you want to plot.
21+
22+
Controls:
23+
* Hover over plot: shows closest point on closest plot
24+
* Click + drag inside plot to zoom
25+
* Double Click inside plot to reset zoom
26+
* Click on legend item to hide it
27+
* Double click on legend item to toggle showing only it and the previous selection
28+
* Click on the title to toggle hiding the plot altogether
29+
* 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.).
30+
831
## Installation
932

1033
```bash

0 commit comments

Comments
 (0)