Klectr/.github
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
9a1b533aca
.github/other_project_defaults
History
Jesse Squires 9a1b533aca
Update README.md
2020-01-27 16:14:01 -08:00
..
build_docs.sh add other default project files 2020-01-25 23:48:51 -08:00
IDETemplateMacros.plist add other default project files 2020-01-25 23:40:40 -08:00
LICENSE add other default project files 2020-01-25 23:40:40 -08:00
lint.sh add other default project files 2020-01-25 23:48:51 -08:00
README.md Update README.md 2020-01-27 16:14:01 -08:00

README.md

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

  • lint.sh: run SwiftLint. Add build phase script in Xcode project: "${SRCROOT}/scripts/lint.sh"

  • build_docs.sh: run Jazzy doc generation.

Templates

  • IDETemplateMacros.plist to customize Xcode header comments. Must be placed in <ProjectName>.xcodeproj/xcshareddata/IDETemplateMacros.plist or <WorkspaceName>.xcworkspace/xcshareddata/IDETemplateMacros.plist.

README template

Boilerplate to add to README.md files.

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

> **Copyright &copy; YEAR-present Jesse Squires.**