Update ProjectSpec.md

This commit is contained in:
Yonas Kolb 2023-04-27 16:59:48 +10:00 committed by GitHub
parent 10b99f1be0
commit 5cad63987e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,62 +1,58 @@
# Project Spec
### Index
- [Project Spec](#project-spec)
- [Index](#index)
- [General](#general)
- [Project](#project)
- [Include](#include)
- [Options](#options)
- [GroupOrdering](#groupordering)
- [FileType](#filetype)
- [Breakpoints](#breakpoints)
- [Breakpoint Action](#breakpoint-action)
- [Configs](#configs)
- [Setting Groups](#setting-groups)
- [Settings](#settings)
- [Target](#target)
- [Product Type](#product-type)
- [Platform](#platform)
- [Sources](#sources)
- [Target Source](#target-source)
- [Dependency](#dependency)
- [Config Files](#config-files)
- [Plist](#plist)
- [Build Script](#build-script)
- [Build Rule](#build-rule)
- [Target Scheme](#target-scheme)
- [Legacy Target](#legacy-target)
- [Aggregate Target](#aggregate-target)
- [Target Template](#target-template)
- [Scheme](#scheme)
- [Build](#build)
- [Common Build Action options](#common-build-action-options)
- [Execution Action](#execution-action)
- [Run Action](#run-action)
- [Test Action](#test-action)
- [Test Target](#test-target)
- [Other Parameters](#other-parameters)
- [Testable Target Reference](#testable-target-reference)
- [Archive Action](#archive-action)
- [Simulate Location](#simulate-location)
- [Scheme Management](#scheme-management)
- [Environment Variable](#environment-variable)
- [Test Plan](#test-plan)
- [Scheme Template](#scheme-template)
- [Swift Package](#swift-package)
- [Remote Package](#remote-package)
- [Local Package](#local-package)
- [Project Reference](#project-reference)
## General
The project spec can be written in either YAML or JSON. All the examples below use YAML.
Required properties are marked with checkbox. Some of the YAML examples don't show all the required properties. For example not all target examples will have a platform or type, even though they are required.
- [x] required property
- [ ] optional property
Some of the YAML examples below don't show all the required properties. For example not all target examples will have a platform or type, even though they are required.
You can also use environment variables in your configuration file, by using `${SOME_VARIABLE}` in a string.
- [Project](#project)
- [Include](#include)
- [Options](#options)
- [GroupOrdering](#groupordering)
- [FileType](#filetype)
- [Breakpoints](#breakpoints)
- [Breakpoint Action](#breakpoint-action)
- [Configs](#configs)
- [Setting Groups](#setting-groups)
- [Settings](#settings)
- [Target](#target)
- [Product Type](#product-type)
- [Platform](#platform)
- [Sources](#sources)
- [Target Source](#target-source)
- [Dependency](#dependency)
- [Config Files](#config-files)
- [Plist](#plist)
- [Build Script](#build-script)
- [Build Rule](#build-rule)
- [Target Scheme](#target-scheme)
- [Legacy Target](#legacy-target)
- [Aggregate Target](#aggregate-target)
- [Target Template](#target-template)
- [Scheme](#scheme)
- [Build](#build)
- [Common Build Action options](#common-build-action-options)
- [Execution Action](#execution-action)
- [Run Action](#run-action)
- [Test Action](#test-action)
- [Test Target](#test-target)
- [Other Parameters](#other-parameters)
- [Testable Target Reference](#testable-target-reference)
- [Archive Action](#archive-action)
- [Simulate Location](#simulate-location)
- [Scheme Management](#scheme-management)
- [Environment Variable](#environment-variable)
- [Test Plan](#test-plan)
- [Scheme Template](#scheme-template)
- [Swift Package](#swift-package)
- [Remote Package](#remote-package)
- [Local Package](#local-package)
- [Project Reference](#project-reference)
## Project
- [x] **name**: **String** - Name of the generated project