From 3a52589c83e594890a71d4767dbb0f38bda977ee Mon Sep 17 00:00:00 2001 From: Pascal Hartig Date: Wed, 27 Jul 2022 07:43:12 -0700 Subject: [PATCH] Update readme Summary: A few small adjustments and updates. Reviewed By: lawrencelomax Differential Revision: D38155923 fbshipit-source-id: 1aea5f9b64a6b5e4783fe7bad214df6a74be7d45 --- packer/README.md | 39 ++++++++++++++++++++++----------------- 1 file changed, 22 insertions(+), 17 deletions(-) diff --git a/packer/README.md b/packer/README.md index d9eccc5de87..bcd11c90193 100644 --- a/packer/README.md +++ b/packer/README.md @@ -1,17 +1,21 @@ # Flipper Packer -A tool for splitting a Flipper build into smaller artifacts that can be distributed and cached separately. +A tool for splitting a Flipper build into smaller artifacts that can be +distributed and cached separately. -**N.B. Buck build files are not included in the open-source export of this tool.** +**N.B. Buck build files are not included in the open-source export of this +tool.** ## Building With cargo: + ``` $ cargo build ``` With Buck: + ``` $ buck build :packer ``` @@ -19,13 +23,15 @@ $ buck build :packer ## Testing With cargo: + ``` $ cargo test ``` With Buck: + ``` -$ buck test :packer +buck test :packer ``` ## Usage @@ -34,29 +40,28 @@ See help page: ``` $ cargo run -- --help -flipper-packer 0.3.0 +flipper-packer 0.4.0 Facebook, Inc. -Split the Flipper distribution into smaller, cacheable artifacts +Helper tool that breaks down a Flipper release into smaller artifacts. USAGE: - flipper-packer [FLAGS] [OPTIONS] + flipper-packer [OPTIONS] -FLAGS: - -h, --help Prints help information - --no-compression Skip compressing the archives (for debugging) - -p, --packlist Custom list of files to pack. - -V, --version Prints version information +ARGS: + Platform to build for OPTIONS: - -d, --dist Flipper dist directory to read from. [default: ~/fbsource/xplat/sonar/dist] - -o, --output Directory to write output files to. [default: .] - -ARGS: - Platform to build for [possible values: Mac, Linux, Windows] + -d, --dist Flipper dist directory to read from [default: + ~/fbsource/xplat/sonar/dist] + -h, --help Print help information + --no-compression Skip compressing the archives (for debugging) + -o, --output Directory to write output files to [default: .] + -p, --packlist Custom list of files to pack + -V, --version Print version information ``` Buck: ``` -$ buck run :packer +buck run :packer ```