jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

Browse Source 
Summary: A few small adjustments and updates.

Reviewed By: lawrencelomax

Differential Revision: D38155923

fbshipit-source-id: 1aea5f9b64a6b5e4783fe7bad214df6a74be7d45
This commit is contained in:
Pascal Hartig
2022-07-27 07:43:12 -07:00
committed by Facebook GitHub Bot
parent 7bfa24ae7b
commit 3a52589c83
1 changed files with 23 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
packer/README.md
View File

@@ -1,17 +1,21 @@
# Flipper Packer # 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 ## Building
With cargo: With cargo:
``` ```
$ cargo build $ cargo build
``` ```
With Buck: With Buck:
``` ```
$ buck build :packer $ buck build :packer
``` ```
@@ -19,13 +23,15 @@ $ buck build :packer
## Testing ## Testing
With cargo: With cargo:
``` ```
$ cargo test $ cargo test
``` ```
With Buck: With Buck:
``` ```
$ buck test :packer buck test :packer
``` ```
## Usage ## Usage
@@ -34,29 +40,28 @@ See help page:
``` ```
$ cargo run -- --help $ cargo run -- --help
flipper-packer 0.3.0 flipper-packer 0.4.0
Facebook, Inc. Facebook, Inc.
Split the Flipper distribution into smaller, cacheable artifacts Helper tool that breaks down a Flipper release into smaller artifacts.
USAGE: USAGE:
flipper-packer [FLAGS] [OPTIONS] <PLATFORM> flipper-packer [OPTIONS] <PLATFORM>
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
OPTIONS:
-d, --dist <DIRECTORY> Flipper dist directory to read from. [default: ~/fbsource/xplat/sonar/dist]
-o, --output <DIRECTORY> Directory to write output files to. [default: .]
ARGS: ARGS:
<PLATFORM> Platform to build for [possible values: Mac, Linux, Windows] <PLATFORM> Platform to build for
OPTIONS:
-d, --dist <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 <OUTPUT> Directory to write output files to [default: .]
-p, --packlist <PACKLIST> Custom list of files to pack
-V, --version Print version information
``` ```
Buck: Buck:
``` ```
$ buck run :packer buck run :packer
``` ```