Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ko1N committed Jun 9, 2024
1 parent 1148763 commit 263540e
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ cargo build --release

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

**The plugin as well as the `memflow.toml` file have to be put in the ReClass `/Plugins` folders.**

## Usage

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

## Configuration

The configuration file offers the following settings:
- `connector` - the name of the connector to use
- `args` - the argument string passed to the connector, optional
- `parse_sections` - will load section information of the process
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:
```toml
connector = "kvm" # the name of the connector to use
args = "" # the argument string passed to the connector, optional
log_level = "info" # changes the memflow logging level, optional
parse_sections = true # will load section information of the process
```

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

**The plugin as well as the `memflow.toml` file have to be put in the ReClass `/Plugins` folders.**

## Remarks

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

0 comments on commit 263540e

Please sign in to comment.