Skip to content

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kennethdsheridan authored Nov 27, 2024
1 parent 5dd547a commit 4314b03
Showing 1 changed file with 0 additions and 19 deletions.
19 changes: 0 additions & 19 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,25 +18,6 @@ cargo build --release
target/release/hardware_report
```

### Use as a Library
You can use `hardware_report` as a library in your Rust project. Add the following to your `Cargo.toml`:

```toml
[dependencies]
hardware_report = { path = "../path/to/hardware_report" }
```

Then, in your Rust code:

```rust
use hardware_report::HardwareReport;

fn main() {
let report = HardwareReport::new().expect("Failed to create hardware report");
report.print_summary();
}
```

## ⚠️ IMPORTANT BUILD REQUIREMENT ⚠️
**DOCKER MUST BE RUNNING ON YOUR LOCAL MACHINE TO COMPILE FOR LINUX ON NON-LINUX SYSTEMS**
**WITHOUT DOCKER RUNNING, THE BUILD WILL FAIL WHEN EXECUTING `make linux` ON macOS OR WINDOWS**
Expand Down

0 comments on commit 4314b03

Please sign in to comment.