2020-01-26 07:40:40 +00:00
# Default project files
This directory contains miscellaneous default project files, like build scripts, etc.
These must be copied to new repositories, and updated with project-specific details.
## Contents
### Scripts
2020-01-28 00:13:37 +00:00
- `lint.sh` : run [SwiftLint ](https://github.com/realm/SwiftLint ). Add build phase script in Xcode project: `"${SRCROOT}/scripts/lint.sh"`
- `build_docs.sh` : run [Jazzy ](https://github.com/realm/jazzy ) doc generation.
2020-01-26 07:40:40 +00:00
### Templates
2020-01-26 07:43:39 +00:00
- `IDETemplateMacros.plist` to [customize Xcode header comments ](https://oleb.net/blog/2017/07/xcode-9-text-macros/ ).
Must be placed in `<ProjectName>.xcodeproj/xcshareddata/IDETemplateMacros.plist` or `<WorkspaceName>.xcworkspace/xcshareddata/IDETemplateMacros.plist` .
## README template
Boilerplate to add to `README.md` files.
```markdown
## Contributing
Interested in making contributions to this project? Please review the guides below.
- [Contributing Guidelines ](https://github.com/jessesquires/.github/blob/master/CONTRIBUTING.md )
- [Code of Conduct ](https://github.com/jessesquires/.github/blob/master/CODE_OF_CONDUCT.md )
- [Support and Help ](https://github.com/jessesquires/.github/blob/master/SUPPORT.md )
- [Security Policy ](https://github.com/jessesquires/.github/blob/master/SECURITY.md )
Also, consider [sponsoring this project ](https://www.jessesquires.com/sponsor/ ) or [buying my apps ](https://www.hexedbits.com )! ✌️
## Credits
Created and maintained by [**@jesse_squires** ](https://twitter.com/jesse_squires ).
## License
Released under the MIT License. See `LICENSE` for details.
2020-01-28 00:13:37 +00:00
> **Copyright © YEAR-present Jesse Squires.**
2020-01-26 07:43:39 +00:00
```