Skip to content
Kevin Conley edited this page Mar 28, 2015 · 4 revisions

###How to contribute If you want to modify how Tesseract-OCR-iOS is implemented, click the "Fork" button in the top-right corner of this page, and then clone your fork from the command line by replacing username with your GitHub username:

git clone [email protected]:username/Tesseract-OCR-iOS.git

There are three projects/targets in Tesseract-OCR-iOS.xcworkspace:

  1. Template Framework Project: This is a well-commented sample app that demonstrates how to use Tesseract-OCR-iOS in an iOS application.
  2. TestsProject: This is a project containing unit tests for testing Tesseract-OCR-iOS. To run the tests, you must first install CocoaPods and run pod install from the root directory of the repository to install the Kiwi unit-testing library. Then, within Xcode, select the TestsProject target and click Product->Test to run all of the unit tests. Xcode will report if all of the tests pass or if any of them fail.
  3. Tesseract OCR (Tesseract OCR iOS project): This project contains the actual implementation of Tesseract-OCR-iOS, so if you want to change how the library works, this is the place to do it.

Once you make your changes, test the library as described above to make sure that your changes have not caused any of the unit tests to fail. If all tests pass, commit your changes to your fork, and then you can submit a pull request back to this repository and we will work with you to merge your changes.

###Active Contributors