Permalink
Browse files

Merge pull request #390 from iRareMedia/master

Interface Polish and Readme Updates
  • Loading branch information...
2 parents 5ec94a8 + 0ebafe9 commit 4010a56dc085ba3027d83241ebcb664889004fe4 @robvdveer robvdveer committed Aug 10, 2013
View
@@ -65,14 +65,18 @@ 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.
+Integrating with Xcode
+-----------------
+You can setup Xcode to automate appledoc document creation. [Find out how](https://github.com/tomaz/appledoc/blob/master/XcodeIntegrationScript.markdown) using a Run Script and your project's Build Phases.
+
Docset usage tips
-----------------
-Pre-generated documentation and docsets for most Cocoa frameworks are available at:
+Pre-generated documentation and docsets for most Cocoa frameworks are available at:
- [CocoaDocs](http://cocoadocs.org)
-Once you have a docset, you might want to use it with a documentation browser:
-- [Xcode](https://developer.apple.com/xcode/)
+Once you have a docset, you might want to use it with a documentation browser:
+- [Xcode](https://developer.apple.com/xcode/)
- [Dash](http://kapeli.com/dash)
Troubleshooting
@@ -91,7 +95,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/tomaz/appledoc/blob/master/Developer%20Notes.markdown) for short overview of how appledoc works internally.
Minimum system requirements
@@ -100,7 +104,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.
View
21 Templates/html/css/styles.css 100755 → 100644
@@ -89,9 +89,9 @@ th {
#contents, #overview_contents {
-webkit-overflow-scrolling: touch;
- border-top: 1px solid #2B334F;
+ border-top: 1px solid #A9A9A9;
position: absolute;
- top: 91px;
+ top: 90px;
left: 0;
right: 0;
bottom: 0;
@@ -186,26 +186,26 @@ th {
#top_header #title {
background: url("../img/title_background.png") repeat-x 0 0 #8A98A9;
- border-bottom: 1px solid #B6B6B6;
+ border-bottom: 1px solid #757575;
height: 25px;
overflow: hidden;
}
#top_header h1 {
- font-size: 115%;
+ font-size: 105%;
font-weight: normal;
margin: 0;
padding: 3px 0 2px;
text-align: center;
- text-shadow: 0 1px 0 #D5D5D5;
+ /*text-shadow: 0 1px 0 #D5D5D5;*/
white-space: nowrap;
}
#headerButtons {
background-color: #D8D8D8;
background-image: url("../img/button_bar_background.png");
- border-bottom: 1px solid #EDEDED;
- border-top: 1px solid #2B334F;
+ border-bottom: 0px solid #EDEDED;
+ border-top: 0px solid #a8a8a8;
font-size: 8pt;
height: 28px;
left: 0;
@@ -227,6 +227,7 @@ th {
}
#toc_button button {
+ background-color: #EBEEF1;
border-color: #ACACAC;
border-style: none solid none none;
border-width: 0 1px 0 0;
@@ -262,14 +263,14 @@ li#jumpto_button select {
}
#tocContainer {
- background-color: #E4EBF7;
- border-top: 1px solid #2B334F;
+ background-color: #EBEEF1;
+ border-top: 1px solid #ACACAC;
bottom: 0;
display: none;
left: 0;
overflow: hidden;
position: absolute;
- top: 91px;
+ top: 90px;
width: 229px;
}
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
@@ -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 automate documentation creation using a run script in Xcode. appledoc can be integrated with Xcode in many ways. Below is one of those ways 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 4010a56

Please sign in to comment.