Files
flipper/packer/README.md
Pascal Hartig 3a52589c83 Update readme
Summary: A few small adjustments and updates.

Reviewed By: lawrencelomax

Differential Revision: D38155923

fbshipit-source-id: 1aea5f9b64a6b5e4783fe7bad214df6a74be7d45
2022-07-27 07:43:12 -07:00

68 lines
1.1 KiB
Markdown

# Flipper Packer
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.**
## Building
With cargo:
```
$ cargo build
```
With Buck:
```
$ buck build :packer
```
## Testing
With cargo:
```
$ cargo test
```
With Buck:
```
buck test :packer
```
## Usage
See help page:
```
$ cargo run -- --help
flipper-packer 0.4.0
Facebook, Inc.
Helper tool that breaks down a Flipper release into smaller artifacts.
USAGE:
flipper-packer [OPTIONS] <PLATFORM>
ARGS:
<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 run :packer
```