From 60af88153027cefafd3871387b485069097b4642 Mon Sep 17 00:00:00 2001 From: Ming Yang Date: Tue, 12 Jul 2011 20:23:55 -0400 Subject: [PATCH] .md version of README --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..35d50a5 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +Install +========================= + +To integrate QR Code Encoder static library with your iOS application, follow the steps below: + + 1. Drag the Xcode project package QRCodeEncoderObjectiveCAtGithub.xcodeproj to your project navigator + + 2. Click on your project. Choose the target. Then go to the Build Phases page. Expand "Target Dependencies" and add qrencoder to the list + + 3. In the same Build Phases page, expand "Link Binary With Libraries", add libqrencoder.a to the list + + 4. Build the project and you are good to go! + +How to Use +========================= + 1. Import QREncoder.h + + 2. Call QREncoder +encodeWithECLevel:(int)ecLevel version:(int)version string:(NSString*)string to encode a string to a square matrix of booleans. + + 3. Call QREncoder +renderDataMatrix:(DataMatrix*)matrix imageDimension:(int)imageDimension to render the matrix generated from step 2. + +Take a look at QRCodeEncoderDemoViewController.mm for encoding and rendering examples. + +Also, since the encoder references C++ code, the implementation files need to have .mm as the extension.