Skip to content
This repository has been archived by the owner on Feb 7, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Brian Clymer authored Jun 6, 2019
1 parent 7f237de commit b3a15a4
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,35 @@
# cocoa-i18n

A description of this package.
## Usage

```
./CocoaLoco generate ~/Resources/LocalizableStrings.json ~/Resources/Output --objc --public --prefix "Base" --bundleName "hudlCapture"
```

1. The first param is the `inputURL` of the json file to process.
1. The second param is the `outputURL`, a directory where the output files should go.
1. `--objc` is optional, and will generate Objective-C compatibility
1. `--public` is optional, and will make the code `public`.
1. `--prefix` will prefix all the files, as well as the files struct / enum names with the provided prefix.
1. `--bundleName`, if you have a static extension on `Bundle` that provides a bundle, use it's name here. Providing `hudlCapture` will result in the code `Bundle.hudlCapture` as the internal bundle for loading the strings.

## Setup

To generate the xcodeproj file, use

```
swift package generate-xcodeproj
```

Then you can open `CocoaLoco.xcodeproj`. Tests won't be passing yet though, because SPM doesn't support resources. You will want to right click on the `Tests/CocoaLocoTests` group and do add files.
...FINISH THIS SECTION

## Creating A Release

```
swift build -c release -Xswiftc "-target" -Xswiftc "x86_64-apple-macosx10.14"
```

It will build to `.build/x86_64-apple-macosx/release/CocoaLoco`. That's your binary!

Eventually this should be distributed through SPM or CocoaPods, but for now we're just floating binaries.

0 comments on commit b3a15a4

Please sign in to comment.