yonaskolb/XcodeGen
1
1
Fork 0
mirror of https://github.com/yonaskolb/XcodeGen.git synced 2025-01-06 04:35:43 +03:00
Code Issues Projects Releases Wiki Activity

mention that JSON specs are also supported

Browse Source
This commit is contained in:
Yonas Kolb 2017-07-30 11:55:07 +02:00
parent 3af1a5b881
commit 8d19f6d420
2 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -18,7 +18,9 @@
# XcodeGen
A command line tool that generates an Xcode project from a YAML project spec and your folder structure.
XcodeGen is a command line tool that generates your Xcode project using your folder structure and a simple project spec.
The project spec is a YAML or JSON file that defines your targets, configurations, schemes and custom build settings. All you source directories are automatically parsed and referenced appropriately while preserving your folder structure. Sensible defaults are used in many places, so you only need to customize what is needed.
- ✅ Easy **configuration** of projects which is human readable and git friendly
- ✅ Groups in Xcode are always **synced** to your directories on disk
@ -96,7 +98,7 @@ This will look for a project spec in the current directory called `xcodegen.yml`
Use `xcodegen help` to see the list of options:
- **--spec**: This is an optional path to the yaml project spec
- **--spec**: This is an optional path to a `.yml` or `.json` project spec
- **--project**: This is an optional path the generated xcode project file. If it is left out, the file will be written to the same directory as the spec, and with the name included in the spec
## Editing

11
docs/ProjectSpec.md
View File

@ -1,9 +1,16 @@
# Project spec
Each spec must contain a name which is used for the generated project name.
The project spec can be written in either YAML or JSON. All the examples below use YAML
### name
Each spec must contain a name which is used for the generated project name
```yaml
name: My Project
```
#### configs
Configs specify the build configurations in the project.
Each config maps to a build type of either `debug` or `release` which will then apply default build settings for those types. Any value other than `debug` or `release` (for example "none"), will mean no default build settings will be loaded
```yaml
configs:
Debug: debug
@ -68,6 +75,7 @@ targets:
```
#### type
This specifies the product type of the target. This will provide default build settings for that product type. Type can be any of the following:
- application
- framework
- library.dynamic
@ -89,6 +97,7 @@ This specifies the product type of the target. This will provide default build s
#### platform
Specifies the platform for the target. This will provide default build settings for that platform. It can be any of the following:
- iOS
- tvOS
- macOS