An Objective-C wrapper for Mac OS X’s FSEvents C API.
Revision | 16a5e026feafafdde0cdb941cc4035d632a67345 (tree) |
---|---|
Zeit | 2011-11-03 02:45:14 |
Autor | Aron Cedercrantz <aron@cede...> |
Commiter | Aron Cedercrantz |
Change the style a bit.
@@ -20,7 +20,7 @@ | ||
20 | 20 | <img border="0" width="90" src="https://github.com/images/modules/download/tar.png"></a> |
21 | 21 | </div> |
22 | 22 | |
23 | - <h1><a href="https://github.com/rastersize/CDEvents">CDEvents</a> API Documentation</h1> | |
23 | + <h1><a href="http://rastersize.github.com/CDEvents">CDEvents</a> <span class="small">API Documentation</span></h1> | |
24 | 24 | |
25 | 25 | |
26 | 26 | <h2>Index</h2> |
@@ -20,25 +20,22 @@ | ||
20 | 20 | <img border="0" width="90" src="https://github.com/images/modules/download/tar.png"></a> |
21 | 21 | </div> |
22 | 22 | |
23 | - <h1><a href="https://github.com/rastersize/CDEvents">CDEvents</a> | |
23 | + <h1><a href="http://rastersize.github.com/CDEvents">CDEvents</a> | |
24 | 24 | <span class="small">by <a href="https://github.com/rastersize">rastersize</a></span></h1> |
25 | 25 | |
26 | 26 | <div class="description"> |
27 | - An Objective-C wrapper for Mac OS X's FSEvents C API. | |
28 | - </div> | |
29 | - | |
30 | - | |
31 | 27 | <p>CDEvents is an Objective-C wrapper for Mac OS X's <a href="http://developer.apple.com/mac/library/documentation/Darwin/Reference/FSEvents_Ref/FSEvents_h/index.html" title="The FSEvents C API documentation on Apples developer site">FSEvents C API</a> with support for blocks. Furthermore, all the classes are immutable and it should be thread-safe.</p> |
28 | + </div> | |
32 | 29 | |
33 | 30 | <h2 id="usage">Usage</h2> |
34 | 31 | <ol> |
35 | 32 | <li>Add CDEvents to your project,</li> |
36 | 33 | <ul> |
37 | - <li>either by compiling the project and dragging the `CDEvents.framework` into your project or</li> | |
34 | + <li>either by compiling the project and dragging the <code>CDEvents.framework</code> into your project or</li> | |
38 | 35 | <li>by dragging the entire CDEvents project into your project as a sub-project.</li> |
39 | 36 | </ul> |
40 | - <li>Import the `CDEvents.h` header where you need it.</li> | |
41 | - <li>Set up your `CDEvents` instance and give it a block to execute when a event occurs.</li> | |
37 | + <li>Import the <code>CDEvents.h</code> header where you need it.</li> | |
38 | + <li>Set up your <code>CDEvents</code> instance and give it a block to execute when a event occurs.</li> | |
42 | 39 | </ol> |
43 | 40 | |
44 | 41 | <p>Short example which will print each event:</p> |
@@ -58,7 +55,7 @@ | ||
58 | 55 | ); |
59 | 56 | }];</pre></code> |
60 | 57 | |
61 | -<p>For a more complete example of usage please see the example application CDEventsTestApp target in the CDEvents Xcode project. Please, also have a look at the <a href="docs/api">API documentation</a>.</p> | |
58 | +<p>For a more complete example of usage please see the example application CDEventsTestApp target in the CDEvents Xcode project. You might also want to check out the <a href="docs/api">API documentation</a>.</p> | |
62 | 59 | |
63 | 60 | <h2 id="documentation">Documentation</h2> |
64 | 61 | <p>View the <a href="docs/api">index of API documentation</a> for all version of CDEvents or go directly to <a href="docs/api/latest"> API documentation for the latest version</a> of CDEvents. Now and then the <a href="docs/api/head">API documentation for HEAD</a> is also updated. The API documentation for all versions of CDEvents can be</p> |
@@ -77,7 +74,7 @@ | ||
77 | 74 | <p> |
78 | 75 | You can download this project in either |
79 | 76 | <a href="https://github.com/rastersize/CDEvents/zipball/master">zip</a> or |
80 | - <a href="https://github.com/rastersize/CDEvents/tarball/master">tar formats. | |
77 | + <a href="https://github.com/rastersize/CDEvents/tarball/master">tar formats.</a> | |
81 | 78 | </p> |
82 | 79 | <p>You can also clone the project with <a href="http://git-scm.com">Git</a> |
83 | 80 | by running: |
@@ -85,13 +82,16 @@ | ||
85 | 82 | </p> |
86 | 83 | |
87 | 84 | <h2>License</h2> |
88 | - <p>Copyright (c) 2010, 2011 Aron Cedercrantz</p> | |
89 | - | |
90 | - <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p> | |
85 | + <p>CDEvents is licensed under the <a href="http://en.wikipedia.org/wiki/MIT_License">MIT license</a> (the Expat version).</p> | |
86 | + <blockquote> | |
87 | + <p>Copyright (c) 2010, 2011 Aron Cedercrantz</p> | |
88 | + | |
89 | + <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p> | |
91 | 90 | |
92 | - <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p> | |
91 | + <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p> | |
93 | 92 | |
94 | - <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p> | |
93 | + <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p> | |
94 | + </blockquote> | |
95 | 95 | |
96 | 96 | <div class="footer"> |
97 | 97 | © 2011 Aron Cedercrantz. View source on <a href="https://github.com/rastersize/CDEvents" title="View source on GitHub (repository: rastersize/CDEvents)">GitHub</a>. |
@@ -14,22 +14,31 @@ li { | ||
14 | 14 | |
15 | 15 | a { |
16 | 16 | text-decoration: none; |
17 | - color: #36C; | |
17 | + /*color: #36C;*/ | |
18 | + color: #db413d; | |
18 | 19 | } |
19 | 20 | |
20 | 21 | a:hover { |
21 | 22 | text-decoration: underline; |
22 | - color: #36C; | |
23 | + /*color: #36C;*/ | |
24 | + color: #db413d; | |
23 | 25 | } |
24 | 26 | |
25 | 27 | h1 { |
26 | - color: #36C; | |
27 | - font-size: 200%; | |
28 | + color: #db413d; | |
29 | + font-size: 275%; | |
30 | + margin-bottom: -.125em; | |
31 | +} | |
32 | + | |
33 | +h1 a, h1 a:hover, h1 a:active, h1 a:focus { | |
34 | + color: #db413d; | |
28 | 35 | } |
29 | 36 | |
30 | 37 | h2 { |
31 | - border-bottom: 1px solid #8391A8; | |
32 | - color: #3C4C6C; | |
38 | + /*border-bottom: 1px solid #8391A8; | |
39 | + color: #3C4C6C;*/ | |
40 | + border-bottom: 4px solid #db413d; | |
41 | + color: #D52823; | |
33 | 42 | font-size: 160%; |
34 | 43 | font-weight: normal; |
35 | 44 | margin-top: 1.75em; |
@@ -50,11 +59,23 @@ p { | ||
50 | 59 | padding-bottom: 2em; |
51 | 60 | } |
52 | 61 | |
62 | +.small { | |
63 | + font-size: 80%; | |
64 | +} | |
65 | + | |
66 | +h1 .small { | |
67 | + font-size: 50%; | |
68 | +} | |
69 | + | |
53 | 70 | #container { |
54 | 71 | margin: 0 auto; |
55 | 72 | width: 700px; |
56 | 73 | } |
57 | 74 | |
75 | +.description { | |
76 | + margin-bottom: -2em; | |
77 | +} | |
78 | + | |
58 | 79 | code { |
59 | 80 | font-family: Courier, Consolas, monospace; |
60 | 81 | font-size: 16px; |
@@ -77,7 +98,7 @@ pre { | ||
77 | 98 | |
78 | 99 | |
79 | 100 | code .keyword, pre .prompt { |
80 | - color: #db403d; | |
101 | + color: #db413d; | |
81 | 102 | } |
82 | 103 | |
83 | 104 | code .method, code .property, pre .command, pre .program { |
@@ -92,7 +113,7 @@ code .class { | ||
92 | 113 | color: #8d5bdb; |
93 | 114 | } |
94 | 115 | |
95 | -code .string { | |
116 | +code .string, pre .argument { | |
96 | 117 | color: #ba5bd7; |
97 | 118 | } |
98 | 119 |