From cf32c8736a5705fd67cec88faef4072a0aa02e40 Mon Sep 17 00:00:00 2001 From: Yonas Kolb Date: Wed, 5 Dec 2018 18:37:17 +1100 Subject: [PATCH] update documentation --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3f9412ac..4f9f0783 100644 --- a/README.md +++ b/README.md @@ -115,17 +115,18 @@ And then import wherever needed: `import XcodeGenKit` Simply run: ```shell -xcodegen +xcodegen generate ``` This will look for a project spec in the current directory called `project.yml` and generate an Xcode project with the name defined in the spec. -To specify any options use the full `xcodegen generate` command and add the following: +Options: - **--spec**: An optional path to a `.yml` or `.json` project spec. Defaults to `project.yml` - **--project**: An optional path to a directory where the project will be generated. By default this is the directory the spec lives in. - **--quiet**: Suppress informational and success messages. - **--use-cache**: Used to prevent unnecessarily generating the project. If this is set, then a cache file will be written to when a project is generated. If `xcodegen` is later run but the spec and all the files it contains are the same, the project won't be generated. +- **--cache-path**: A custom path to use for your cache file. This only has an affect is `--use-cache` is passed. This defaults to `~/.xcodegen/cache/{PROJECT_SPEC_PATH_HASH}` Use `xcodegen help` to see more detailed usage information.