Permalink
Browse files

Readme Cleanup

Readme maintenance includes formatting fixes, grammar and spelling
fixes, and in-text refrence links.
  • Loading branch information...
1 parent 0cffbec commit 7e9a7089bb3d72596f9a3144ff9269af8aef558c @Sam-Spencer Sam-Spencer committed Aug 9, 2013
Showing with 34 additions and 33 deletions.
  1. +4 −2 Readme.markdown
  2. +30 −31 XcodeIntegrationScript.markdown
View
@@ -65,6 +65,8 @@ To keep up to date, just go to Terminal and cd into appledoc directory, issue `g
If you also want to compile and run AppledocTests (unit tests) target, you need to copy all the frameworks indicated within Libraries & Frameworks group to shared frameworks directory before building unit tests target! This is not required for building the appledoc tool itself.
+You can also setup Xcode to automate appledoc documentation creation. [Find out how](https://github.com/iRareMedia/appledoc/blob/master/XcodeIntegrationScript.markdown).
+
Docset usage tips
-----------------
@@ -91,7 +93,7 @@ Have problems? This is what you can do to troubleshoot:
Developer notes
---------------
-If you wish to contribute, see Developer Notes file for short overview of how appledoc works internally.
+If you wish to contribute, see the [Developer Notes file](https://github.com/iRareMedia/appledoc/blob/master/Developer%20Notes.markdown) for short overview of how appledoc works internally.
Minimum system requirements
@@ -100,7 +102,7 @@ Minimum system requirements
- Xcode 4.5 or greater for compiling
- OS X 10.7 for compiling and running
-LICENSE
+License
=======
appledoc is licensed with modified BSD license. In plain language: you're allowed to do whatever you wish with the code, modify, redistribute, embed in your products (free or commercial), but you must include copyright, terms of usage and disclaimer as stated in the license, the same way as any other BSD licensed code. You can of course use documentation generated by appledoc for your products (free or commercial), but you must attribute appledoc either in documentation itself or other appropriate place such as your website.
@@ -1,11 +1,10 @@
-Sample script to Enamble Xcode integration
+Xcode Integration Script
==========================================
-
-appledoc can be integrated with Xcode in many ways. Below is one of those to get you up and running quickly on Xcode 4.6
+Sample Script to automoate documentation creation using a run script in Xcode. appledoc can be integrated with Xcode in many ways. Below is one of those to get you up and running quickly on Xcode 4.6
1. Select top of your project in Project Navigator
2. Click Add Target
-3. Depending on your project type (IOS or OS X) choose Aggregate Template
+3. Depending on your project type (iOS or OS X) choose Aggregate Template
4. Create new target. I suggest to call it Documentation
5. Click on Build Phases and add new Build Phase based on Script
6. Paste the script below into the script window
@@ -16,31 +15,31 @@ appledoc can be integrated with Xcode in many ways. Below is one of those to get
11. Docset will be installed into new loction and will become available to Xcode immediately.
12. To refresh Quick Help (ALT+Click) and (ALT+double-click) you may need to restart Xcode to refresh its index cache.
+Below is a working script that can be added to the Xcode Build Phases, Run Script
-
-#appledoc Xcode script
-# Start constants
-company="ACME";
-companyID="com.ACME";
-companyURL="http://ACME.com";
-target="iphoneos";
-#target="macosx";
-outputPath="~/help";
-# End constants
-/usr/local/bin/appledoc \
---project-name "${PROJECT_NAME}" \
---project-company "${company}" \
---company-id "${companyID}" \
---docset-atom-filename "${company}.atom" \
---docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \
---docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \
---docset-fallback-url "${companyURL}/${company}" \
---output "${outputPath}" \
---publish-docset \
---docset-platform-family "${target}" \
---logformat xcode \
---keep-intermediate-files \
---no-repeat-first-par \
---no-warn-invalid-crossref \
---exit-threshold 2 \
-"${PROJECT_DIR}"
+ #appledoc Xcode script
+ # Start constants
+ company="ACME";
+ companyID="com.ACME";
+ companyURL="http://ACME.com";
+ target="iphoneos";
+ #target="macosx";
+ outputPath="~/help";
+ # End constants
+ /usr/local/bin/appledoc \
+ --project-name "${PROJECT_NAME}" \
+ --project-company "${company}" \
+ --company-id "${companyID}" \
+ --docset-atom-filename "${company}.atom" \
+ --docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \
+ --docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \
+ --docset-fallback-url "${companyURL}/${company}" \
+ --output "${outputPath}" \
+ --publish-docset \
+ --docset-platform-family "${target}" \
+ --logformat xcode \
+ --keep-intermediate-files \
+ --no-repeat-first-par \
+ --no-warn-invalid-crossref \
+ --exit-threshold 2 \
+ "${PROJECT_DIR}"

0 comments on commit 7e9a708

Please sign in to comment.