Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Recipes #1404

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

roman-aliyev
Copy link

PR adds production-ready solutions for common xcode tasks.

Idea

Each recipe contains complete project.yml and project's file structure. There is also a diff highlighting to highlight the key points that are related to one specific task (unit testing, environments, etc). See this example or other files attached to this PR.

Why?

Xcodegen contains fairly good documentation. But it focuses on xcodegen features and specs. It would be great if the documentation also described solutions to common development tasks with ready-to-use specs.

How to use

By copy-pasting the part or all of project.yml into your app's project.yml file.

Recipe template

# [Name of the recipe]


## Description

[Description]

## File structure

```diff
 .
 ├── Directory
+│   ├── HighlightedFile
 │   └── File.swift
 └── project.yml
```

## project.yml

```diff
 code
+highlighted code
 code
```

Copy link
Owner

@yonaskolb yonaskolb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@roman-aliyev I appreciate the work that went into this, and can definitely see it being useful for people. I just can't commit to maintaining these. I'm happy to link out to a repo that you maintain

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants