Skip to content

Latest commit

 

History

History
29 lines (25 loc) · 1.19 KB

BUILDING.md

File metadata and controls

29 lines (25 loc) · 1.19 KB

How to build

  1. Download and install Rust from https://www.rust-lang.org/
  2. Git clone the repo
  3. Navigate to cloned repo.
  4. Execute cargo build to build debug library. cargo build --release to build release version
    • Navigate to examples directory and run cargo build --release to build the example files
    • unifiedlog_parser and unifiedlog_parser_json can parse a live macOS system if no arguements are presented. Both can also parse a logarchive if passed as an arguement

Running test suite

  1. Follow steps above
  2. Download tests.zip from Github releases
  3. Copy/move tests.zip to clone repo
  4. Decompress tests.zip
  5. Execute cargo test --release to run tests
    • You can also just use cargo test to run tests but it will be slower

Running benchmarks

  1. Download tests.zip from Github releases
  2. Copy/move tests.zip to clone repo
  3. Decompress tests.zip
  4. Run cargo bench
    or
  5. Install criterion, cargo install cargo-criterion
  6. Run cargo criterion