p2 avatar p2 committed c60e3a5

Better setup instructions

Comments (0)

Files changed (2)

 [apache]: http://www.apache.org/licenses/LICENSE-2.0.html
 
 
+Setup
+-----
+
+Here's one way on how you can use SQLiteKit for your app:
+
+1. Use git to clone the kit as a submodule (if you use git, otherwise just use `git clone`):  
+ 
+       cd your-project
+       git submodule add git://github.com/p2/sqlk.git
+
+2. Add the **sqlk** project to your Xcode workspace
+3. Go to your app's build settings and add this to your **User Header Search Paths**, with **recursive** enabled:
+   
+       "$(PROJECT_DIR)"
+
+4. Go to your app's build phases and add these two frameworks:
+   
+       libsqlite3.dylib
+       libsqlk.a
+
+
 Using SQLiteObject
 ------------------
 
 Using the kit
 -------------
 
-The rest of the kit provides ways to create and update your SQLite database. If you want to use this functionality you can either use it as a subproject in your Xcode workspace or add the files like they were your own. Then link your app with:
-
-* libsqlite3.dylib
-* libsqlk.a
-
-The kit can read database structures from an XML file and create a database that represents this schema, and even update existing databases to match the schema, within the constraints of SQLite. Remember, SQLite can not rename or delete table columns.
+The rest of the kit provides ways to create and update your SQLite database. it can read database structures from an XML file and create a database that represents this schema, and even update existing databases to match the schema, within the constraints of SQLite. Remember, SQLite can not rename or delete table columns.
 
 
 ### XML Schema ###

sqlk.xcodeproj/project.pbxproj

 		EE08DE7A15A9E24E00CF6086 /* README.md */ = {isa = PBXFileReference; lastKnownFileType = text; path = README.md; sourceTree = "<group>"; };
 		EE08DE8715A9E44D00CF6086 /* database1.xml */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xml; path = database1.xml; sourceTree = "<group>"; };
 		EE08DE9115A9EE2100CF6086 /* database2.xml */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xml; path = database2.xml; sourceTree = "<group>"; };
-		EE2D916D12872C8700C69142 /* SQLiteObject.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; lineEnding = 0; name = SQLiteObject.h; path = Classes/SQLiteObject.h; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.objcpp; };
+		EE2D916D12872C8700C69142 /* SQLiteObject.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; lineEnding = 0; name = SQLiteObject.h; path = Classes/SQLiteObject.h; sourceTree = "<group>"; };
 		EE2D916E12872C8700C69142 /* SQLiteObject.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SQLiteObject.m; path = Classes/SQLiteObject.m; sourceTree = "<group>"; };
 		EE2D916F12872C8700C69142 /* SQLKColumnStructure.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SQLKColumnStructure.h; sourceTree = "<group>"; };
 		EE2D917012872C8700C69142 /* SQLKColumnStructure.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; lineEnding = 0; path = SQLKColumnStructure.m; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.objc; };
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.