yonaskolb/XcodeGen
1
1
Fork 0
mirror of https://github.com/yonaskolb/XcodeGen.git synced 2024-09-17 15:47:08 +03:00
Code Issues Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
Yonas Kolb 2018-12-05 18:37:17 +11:00
parent ed80164a4d
commit cf32c8736a
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -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.