cli: Update README

Changes

1 changed files (+22/-2)

• cli/README.md
  • @@ -18,5 +18,25 @@ -->
    # CLI - CLI is for designing core and GUI elements. - This is not intended for real-world uses. + Simple command line application for accessing Roon API. + + This is not intended for real-world uses—the sole reason of this program is to test core's functionality. + Because this program does not have any runtime dependencies, you can easily check memory errors and profile using tools such as Valgrind. + + ## Development + + ### Building + + ``` + zig build + ``` + + This command builds and outputs binary to `zig-out/bin/plac`. + + ### Enable freelog + + To output debug log for releasing memory, enable `-Dfreelog` build option: + + ``` + zig build -Dfreelog + ```