Skip to content

Commit 263540e

Browse files
committed
Updated readme
1 parent 1148763 commit 263540e

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ cargo build --release
1414

1515
The resulting plugin can be found under `./target/release/libmemflow_reclass.so` (or dll on windows).
1616

17-
**The plugin as well as the `memflow.toml` file have to be put in the ReClass `/Plugins` folders.**
18-
1917
## Usage
2018

2119
After the plugin has been copied to the `./Plugins` folder in ReClass it can be selected as a plugin inside of ReClass.
@@ -26,13 +24,18 @@ More information on access rights can be found in the [memflow repository](https
2624

2725
## Configuration
2826

29-
The configuration file offers the following settings:
30-
- `connector` - the name of the connector to use
31-
- `args` - the argument string passed to the connector, optional
32-
- `parse_sections` - will load section information of the process
27+
The `memflow.toml` file is used to configure the plugin and configure the memflow connector that should be used. The file has the following format:
28+
```toml
29+
connector = "kvm" # the name of the connector to use
30+
args = "" # the argument string passed to the connector, optional
31+
log_level = "info" # changes the memflow logging level, optional
32+
parse_sections = true # will load section information of the process
33+
```
3334

3435
Depending on the Connector you use it might be useful to disable section parsing as this slow down the ReClass UI.
3536

37+
**The plugin as well as the `memflow.toml` file have to be put in the ReClass `/Plugins` folders.**
38+
3639
## Remarks
3740

3841
This plugin is still work in progress and some features might not yet work as expected.

0 commit comments

Comments
 (0)