Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
Summary: A few small adjustments and updates.

Reviewed By: lawrencelomax

Differential Revision: D38155923

fbshipit-source-id: 1aea5f9b64a6b5e4783fe7bad214df6a74be7d45
  • Loading branch information
passy authored and facebook-github-bot committed Jul 27, 2022
1 parent 7bfa24a commit 3a52589
Showing 1 changed file with 22 additions and 17 deletions.
39 changes: 22 additions & 17 deletions packer/README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,37 @@
# 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
```

## Testing

With cargo:

```
$ cargo test
```

With Buck:

```
$ buck test :packer
buck test :packer
```

## Usage
Expand All @@ -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>
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
ARGS:
<PLATFORM> Platform to build for
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:
<PLATFORM> Platform to build for [possible values: Mac, Linux, Windows]
-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
```

0 comments on commit 3a52589

Please sign in to comment.