Эх сурвалжийг харах

Updated read me so you could see what change was made

Rob Ryan 12 жил өмнө
parent
commit
c6237ba8f8
1 өөрчлөгдсөн 12 нэмэгдсэн , 0 устгасан
  1. 12 0
      README.markdown

+ 12 - 0
README.markdown

@@ -1,6 +1,18 @@
 # FMDB
 This is an Objective-C wrapper around SQLite: http://sqlite.org/
 
+> This version of FMDB consists of solely changes to the .h files, adding comments. These comments hopefully make the .h more readable, but just as importantly, can be parsed by [`appledoc`](http://gentlebytes.com/appledoc/) to create a help file like found at http://robertmryan.github.io/fmdb.
+>
+> To build that help documentation, once you've installed `appledoc`, you issue the command:
+>
+>     appledoc --project-name FMDB --project-company ccgus --explicit-crossref --no-merge-categories --output ../Documentation .
+>
+> If you want online help integrated right into Xcode, you can issue the command:
+>
+>     appledoc --project-name FMDB --project-company ccgus --explicit-crossref --merge-categories --install-docset --output ../Documentation .
+>
+> Robert M. Ryan, 3 June 2013
+
 
 ## The FMDB Mailing List:
 http://groups.google.com/group/fmdb