Updated readme

pull/7/head
ko1N 4 years ago
parent bd714e1f16
commit 4d45353e4b

@ -11,9 +11,7 @@ More information about pcileech can be found under https://github.com/ufrisk/pci
First make sure that the `leechcore` submodule is checked out:
```
git submodule init
git submodule sync
git submodule update
git submodule update --init
```
Install the following build tools:
@ -31,12 +29,14 @@ More information about these requirements can be found in the [LeechCore-Plugins
To run the example simply execute:
```cargo run --example read_phys --release -- FPGA```
```
cargo run --example read_phys --release -- FPGA
```
On Linux the example binary will be ran with `sudo -E` to elevate privileges.
Since the invoked binary is placed in the `target/release/examples` or `/target/debug/examples` folder the `leechcore_ft601_driver_linux.so` has to be placed in the corresponding folder.
On Windows the `FTD3XX.dll` has to be placed in the corresponding examples folder as well.
On Windows the `FTD3XX.dll` has to be placed in the corresponding examples folder.
### Installing the library
@ -51,7 +51,9 @@ Remarks: The `install.sh` script does currently not place the `leechcore_ft601_d
The stand-alone connector of this library is feature-gated behind the `inventory` feature.
To compile a dynamic library for use with the connector inventory use the following command:
```cargo build --release --all-features```
```
cargo build --release --all-features
```
As mentioned above the `leechcore_ft601_driver_linux.so` or `FTD3XX.dll` have to be placed in the same folder the connector library is placed in.
@ -59,7 +61,7 @@ As mentioned above the `leechcore_ft601_driver_linux.so` or `FTD3XX.dll` have to
To use the plugin in a rust project just include it in your Cargo.toml
```
```toml
memflow-pcileech = { git = "https://github.com/memflow/memflow-pcileech", branch = "master" }
```
@ -67,7 +69,7 @@ Make sure to _NOT_ enable the `plugin` feature when importing multiple
connectors in a rust project without using the memflow plugin inventory.
This might cause duplicated exports being generated in your project.
After adding the dependency to your Cargo.toml you can easily create a new Connector instance and pass it some args:
After adding the dependency to your Cargo.toml you can easily create a new Connector instance and pass it some arguments from the command line:
```rust
let args: Vec<String> = env::args().collect();

Loading…
Cancel
Save