diff --git a/README.md b/README.md index b5b7ca2..aed2604 100644 --- a/README.md +++ b/README.md @@ -15,12 +15,16 @@ Your new Swift 3 module will immediately have working, compilable code, and all - Turnkey access to Travis CI - Semantic versioning and a CHANGELOG -## How to Use This +## How to use this Clone or [download a release](https://github.com/fulldecent/swift-package/releases) and run the `./configure` program. It will ask you some questions and generate a project. You then add all the interesting features you want your module to have. +### Using CocoaPods to manage dependencies for your example app + +You distribute an example app with your new Swift module to show that it works. You may also decide to add UI tests to your example app and some people like to use testing frameworks for those UI tests. If you would like to use CocoaPods to manage the dependencies of your example app, please see the discussion at https://github.com/fulldecent/swift3-module-template/issues/8. + ## Contributing See the file [`Recipe.md`](Recipe.md) for the complete steps (e.g. Open Xcode, make new project, click here, type that, ...) of how we made the template. diff --git a/Recipe.md b/Recipe.md index a3a8d17..7b0559b 100644 --- a/Recipe.md +++ b/Recipe.md @@ -265,20 +265,20 @@ Complete all these instructions on the same calendar day. 1. Replace occurrences of "Created by XXX on YYY" with "Created by `__AUTHOR NAME__` on `__TODAYS_DATE__`" - 2. Replace occurrences of "Copyright © 2016" with "Copyright © __TODAYS_YEAR__" + 2. Replace occurrences of "Copyright © 2016" with "Copyright © `__TODAYS_YEAR__`" 6. Use Terminal.app to add additional files to the project - cd ~/Desktop/__PROJECT_NAME__/ - curl 'https://raw.githubusercontent.com/github/gitignore/master/Swift.gitignore' -o .gitignore - echo '__PROJECT_NAME__.framework.zip' >> .gitignore - curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/.travis.yml' -o .travis.yml - curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/LICENSE' -o LICENSE - curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/README.md' -o README.md - curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/CHANGELOG.md' -o CHANGELOG.md - curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/CONTRIBUTING.md' -o CONTRIBUTING.md - echo '3.0' > .swift-version - # Reference https://github.com/Alamofire/Alamofire/blob/master/.swift-version - # Reference https://github.com/CocoaPods/CocoaPods/pull/5841 - curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/Tests/CheckCocoaPodsQualityIndexes.rb' -o Tests/CheckCocoaPodsQualityIndexes.rb - curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/Project.swift' -o Project.swift + cd ~/Desktop/__PROJECT_NAME__/ + curl 'https://raw.githubusercontent.com/github/gitignore/master/Swift.gitignore' -o .gitignore + echo '__PROJECT_NAME__.framework.zip' >> .gitignore + curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/.travis.yml' -o .travis.yml + curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/LICENSE' -o LICENSE + curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/README.md' -o README.md + curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/CHANGELOG.md' -o CHANGELOG.md + curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/CONTRIBUTING.md' -o CONTRIBUTING.md + echo '3.0' > .swift-version + # Reference https://github.com/Alamofire/Alamofire/blob/master/.swift-version + # Reference https://github.com/CocoaPods/CocoaPods/pull/5841 + curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/Tests/CheckCocoaPodsQualityIndexes.rb' -o Tests/CheckCocoaPodsQualityIndexes.rb + curl 'https://raw.githubusercontent.com/fulldecent/swift3-module-template/master/__PROJECT_NAME__/Project.swift' -o Project.swift diff --git a/__PROJECT_NAME__/__PROJECT_NAME__.xcodeproj/project.pbxproj b/__PROJECT_NAME__/__PROJECT_NAME__.xcodeproj/project.pbxproj index 4973928..b892e20 100644 --- a/__PROJECT_NAME__/__PROJECT_NAME__.xcodeproj/project.pbxproj +++ b/__PROJECT_NAME__/__PROJECT_NAME__.xcodeproj/project.pbxproj @@ -97,8 +97,7 @@ children = ( D95E1BF81D88E01300F94976 /* wk.png */, ); - name = Resources; - path = Tests; + path = Resources; sourceTree = ""; }; /* End PBXGroup section */