Skip to content

Commit

Permalink
readme & screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
carloe committed Jun 12, 2015
1 parent 835d632 commit a111b08
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,26 @@
#Settings Bundle License Generator
Recursively finds all LICENSE.* files in the input directory and generates a Settings.bundle friendly plist.
#LicenseGenerator iOS
Recursively finds all `LICENSE.*` files in a given directory and generates a `Settings.bundle` friendly plist.

The script can help ensure that the license section of your app is always up to date. Since it searches recursively the script works well with cocoapods projects. It assumes that the parent directory of the LICENSE file is also the name of the library to be credited.
![](screenshot.jpg)

Inspired by JosephH and Sean's comments on [stackoverflow](http://stackoverflow.com/q/6428353).
The script can help ensure that the license section of your app is always up to date. Since it searches recursively the script works well with cocoapods projects. It assumes that the parent directory of the `LICENSE` file is also the name of the library to be credited.

##Using it as a build script
Inspired by JosephH and Sean's comments on [stackoverflow](http://stackoverflow.com/q/6428353).

##Usage as xcode build script

* Copy `credits.py` to the your project root
* Open your project, select your **Target** and select **Build Phases**
* Add a new **Run Script Phase** after target dependencies
* Add something like: `./credits.py -d $SRCROOT -o $SRCROOT/MyProj/Settings.bundle/Credits.plist`
* Add something like: `./credits.py -s $SRCROOT -o $SRCROOT/MyProj/Settings.bundle/Credits.plist`
* Build & profit

##Excluding Directories
You can optionally tell the generator to ignore certain paths. To do so use the `-e` option and pass it a comma seperated list of path fragments.

##Contact
Twitter: [@carloeugster](https://twitter.com/carloeugster)
Email: [[email protected]](mailto:[email protected])

##License
MIT
Binary file added screenshot.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a111b08

Please sign in to comment.