Skip to content
Browse files

documentation: + Installation , + Odds and Ends

  • Loading branch information...
1 parent bf046f9 commit a81dd2653ed0e33bdade91708adb3e879a474499 @orangeraven orangeraven committed Aug 29, 2010
Showing with 26 additions and 2 deletions.
  1. +26 −2 README.markdown
View
28 README.markdown
@@ -1,8 +1,32 @@
# Finder Toolbar Items
-## Documentation
+A collection of scripts & icons for Finder.app toolbar items (droplets & applets) and a Rakefile to produce the corresponding .app's.
-... coming soon ...
+## Installation
+
+There are two ways to use this:
+
+1. The I-Just-Want-To-Use-This way
+
+ * download a pre-built archive from the [project's Github Downloads](http://github.com/Orangenhain/Finder-Toolbar-Items/downloads) page
+ * unpack it to somewhere you feel comfortable with
+ * drag & drop the files into your Finder's toolbar
+
+2. The DIY way
+
+ * clone the repository
+ * `cd` to resulting directory & maybe modify the icons or scripts
+ * run `rake` - this will result in all the toolbar items being built into a folder specified in the Rakefile
+
+ You can also run `rake "toolbar item name"` to just get a specific item.
+
+ Change the `DROPLET_DIR` constant in the Rakefile to have the resulting items be built into a directory of your choosing. The path is relative, i.e. using `../toolbar-items` is possible.
+
+## Odds and Ends
+
+There is a `_droplet.png` file in the repository you can use to create your own droplet icons.
+
+If someone has a higher-resolution of that image, please let me know.
## Credits & Contributors

0 comments on commit a81dd26

Please sign in to comment.
Something went wrong with that request. Please try again.