Update readme
Summary: A few small adjustments and updates. Reviewed By: lawrencelomax Differential Revision: D38155923 fbshipit-source-id: 1aea5f9b64a6b5e4783fe7bad214df6a74be7d45
This commit is contained in:
committed by
Facebook GitHub Bot
parent
7bfa24ae7b
commit
3a52589c83
@@ -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] <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: .]
|
||||
flipper-packer [OPTIONS] <PLATFORM>
|
||||
|
||||
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 run :packer
|
||||
buck run :packer
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user