Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pinwhell authored Jun 10, 2024
1 parent 8b36e95 commit a3b1f14
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,35 @@
- **Command-Line Interface (CLI)**: MHTR offers a CLI interface for convenient interaction, allowing users to specify targets, configure options, and generate reports.

- **Multithreading**: To enhance performance, MHTR employs multithreading to parallelize metadata lookup operations across multiple targets.



## CLI Quick Start

To quickly get started with the MHCLI tool and generate results from the samples directory, follow these steps:

### Step 1: Navigate to the Samples Directory

Ensure that you are in the directory containing the `targets.json` file. If not, navigate to the samples directory using the `cd` command:
```bash
cd path/to/samples
```
Replace `path/to/samples` with the actual path to your samples directory.

### Step 2: Run MHCLI Command

Execute the following command to run MHCLI with the specified parameters:

```bash
MHCLI --targets targets.json --report rs.txt --rhpp rs.hpp --rhpprt rs.rt.hpp
```
Make sure that `MHCLI` is included in your system's PATH directory, or provide the full path to the `MHCLI` executable if it's not.

### Step 3: Verify Results

After executing the command, MHCLI will generate the results in the specified files (`rs.txt`, `rs.hpp`, `rs.rt.hpp`). You can then review these files to analyze the output generated by MHCLI.

That's it! You've successfully run MHCLI on the samples directory and generated results.

## Integrated Plugin/Add-ons System

Extend MHTR's functionality with an integrated plugin system, enabling users to add custom features and tools. This system allows for the development and integration of additional modules, enhancing the tool's capabilities and adapting to specific analysis needs.
Expand Down

0 comments on commit a3b1f14

Please sign in to comment.