Skip to content

Commit

Permalink
updated README.md to include new options
Browse files Browse the repository at this point in the history
  • Loading branch information
Gummientchen committed May 20, 2024
1 parent bfce33c commit 0e8331d
Showing 1 changed file with 32 additions and 8 deletions.
40 changes: 32 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,48 @@ This tool helps visualize PresentMon logs.

## Basic usage:

| Option | Long Option | Description |
| ------ | ----------- | ------------------------------------------------------------- |
| -h | | Shows the integrated help |
| -i | -Input | Specifies the input .csv file from PresentMon |
| -o | -Output | Specifies a custom output path. Must be .png |
| -t | -Title | Set custom title which is shown at the top of generated image |
| -b | -Bins | Defines how many bins should be used for histograms |
| Option | Long Option | Description |
| ------ | ----------- | ----------------------------------------------------------------------------------- |
| -h | | Shows the integrated help |
| -i | -Input | Specifies the input .csv file from PresentMon |
| -o | -Output | Specifies a custom output path. Must be .png |
| -t | -Title | Set custom title which is shown at the top of generated image |
| -b | -Bins | Defines how many bins should be used for histograms |
| -d | -Theme | Lets you choose between dark and light mode. Default dark. Options: "dark", "light" |
| -s | -ShowWindow | If set shows a preview window of the graph (image still gets stored) |

## Examples

```cmd
PresentMon-Grapher.exe -i "presentmon-log.csv"
```

### Define Output Path

```cmd
PresentMon-Grapher.exe -i "C:\presentmon-log.csv" -o "C:\presentmon-log.png"
```

### Set Number of Bins

```cmd
PresentMon-Grapher.exe -i "C:\presentmon-log.csv" -b 40
```

### Light Mode

```cmd
PresentMon-Grapher.exe -i "C:\presentmon-log.csv" -d light
```

### Show Preview Window

```cmd
PresentMon-Grapher.exe -i "C:\presentmon-log.csv" -s
```

### All Options Combined

```cmd
PresentMon-Grapher.exe -i "C:\presentmon-log.csv" -o "C:\presentmon-log.png" -b 40
PresentMon-Grapher.exe -i "C:\presentmon-log.csv" -o "C:\presentmon-log.png" -b 40 -d light -s
```

0 comments on commit 0e8331d

Please sign in to comment.