Skip to content

Commit

Permalink
Merge branch 'master' of github.com:fulldecent/swift3-module-template
Browse files Browse the repository at this point in the history
* 'master' of github.com:fulldecent/swift3-module-template:
  Corrected filesystem path of „Resources“
  Code block escape terminal commands
  Code escape __TODAYS_YEAR__
  Add CocoaPods notes.
  • Loading branch information
fulldecent committed Dec 3, 2016
2 parents 880e05d + 26868bd commit 5ae20b5
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 17 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
28 changes: 14 additions & 14 deletions Recipe.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions __PROJECT_NAME__/__PROJECT_NAME__.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,7 @@
children = (
D95E1BF81D88E01300F94976 /* wk.png */,
);
name = Resources;
path = Tests;
path = Resources;
sourceTree = "<group>";
};
/* End PBXGroup section */
Expand Down

0 comments on commit 5ae20b5

Please sign in to comment.