Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 3.2 KB

README.md

File metadata and controls

53 lines (39 loc) · 3.2 KB

iOS app sample project

This is a sample Xcode project for empty iOS application. It allows to quickly and comfortably deploy a workspace for new ready-to-code Xcode project.

What does it include?

Sample project contains following configured features:

Logic unit testing

In order to provide unit testing for the classes of your app, you need to complete these steps. They are already configured in this project.

Application unit testing

Application unit testing allows to perform unit tests on actual device (or simulator as well). These instuctions are completed in current project and ready to test. Additionaly, you can enjoy using OCMock library functionality in your tests.

Documentation

Appledoc allows apple-style documentation generation based on comments left in code. It is configured by AppledocSettings.plist file. The script for documentation generation is placed in Documentation target of a project and is executed upon app archiving. Script executes appledoc command (so it will not work if you don't have appledoc installed on your system) and archives generated HTML documentation folder into .tar.bz file.

Logging

Project is configured to use PTNLogger (see PTNArtifacts for more details).

Storage

Project is configured to use PTNStorage (see PTNArtifacts for more details).

How to use

  1. Clone PTNSampleProject into folder named corresponds to your new project.
  2. Run setup.sh script with the name of your project as an argument.
  3. Start developing

Example

For instance, you are going to start awesome app called SuperApp. Here are steps you need to perform before starting to write code:

$ git clone https://github.com/peetonn/PTNSampleProject SuperApp
$ cd SuperApp
$ ./setup.sh SuperApp

That's it! Now you just open SuperApp.xcworkspace (if you declined to open it from setup.sh script) and Xcode drops you to your new configured ready-to-code environment!

Enjoy your code!