Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathan Mitchell committed May 15, 2012
1 parent 2698789 commit 9454fab
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ The full [ASDictionary][asdictionary] generated documentation set and downloadab
To add a new AppleScript documentation set:

1. Clone this.
2. Run the [ASDictionary][asdictionary] tool on the application bundle and generate an HTML AppleScript document set.
2. Run the [ASDictionary][asdictionary] tool on the application bundle and generate an HTML AppleScript document set. When generating the dictionary documentation ensure that under **File Formats** both `HTML (Frames)` and `compact classes` are selected. The required **Terminology style** option is `AppleScript`.

3. Insert the generated HTML into the `Applications` folder hierarchy using the template below.
4. Send us a pull.

Expand All @@ -21,15 +22,15 @@ Folder hierarchy template:

#Email submission

ASDictionary generated documentation will also be accepted by email for inclusion in this archive. Send the following to `support@mugginsoft.com`.
[ASDictionary][asdictionary] generated documentation will also be accepted by email for inclusion in this archive. Send the following to `support@mugginsoft.com`.

1. Application company name (Apple, Adobe, etc).
2. Application name and link.
3. OS X version of machine that generated the header (OS X 10.6 and above only please).
3. OS X version of machine that generated the documentation (OS X 10.6 and above only please).
4. Application version as quoted in the About panel.
5. The html documentation itself, either in the body of the email or as an attachment. Use the [ASDictionary][asdictionary] tool.
5. The html documentation itself, either in the body of the email or as an attachment. Use the [ASDictionary][asdictionary] tool as detailed above.

[asdictionary]:http://appscript.sourceforge.net/tools.html
[asdictionary]:http://www.mugginsoft.com/content/ASDictionary

[mugginsoft]:http://www.mugginsoft.com/kosmictask/ScriptingBridge

Expand Down

0 comments on commit 9454fab

Please sign in to comment.