diff --git a/README.md b/README.md index e992caa..d77bfe7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ Run benchmarks, collect data! +## CLI usage + +* Ensure python3 is installed +* Copy the `config/farm.cfg.example` to `config/farm.cfg` and edit if needed. If device_type is CPU, device_name will be ignored. +* Run `benchmark/farm.py` +* The results will be stored in the output_dir specified in `config/farm.cfg` + + ## Build for release ### macOS