https://github.com/rubyonworld/ruby-dictionary
You will need latest Command Line Tools for Xcode.
https://github.com/rubyonworld/ruby-dictionary
command line ruby tool xcode
Last synced: 6 months ago
JSON representation
You will need latest Command Line Tools for Xcode.
- Host: GitHub
- URL: https://github.com/rubyonworld/ruby-dictionary
- Owner: RubyOnWorld
- Created: 2022-09-27T15:37:27.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-09-28T00:58:13.000Z (over 3 years ago)
- Last Synced: 2025-05-19T20:32:46.054Z (10 months ago)
- Topics: command, line, ruby, tool, xcode
- Language: Ruby
- Homepage:
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.markdown
Awesome Lists containing this project
README
This gem adds `rubydictionary` formatter to RDoc.
## Prerequisites
You will need latest [Command Line Tools for Xcode](https://developer.apple.com/downloads/index.action).
### Dictionary Development Kit
Since OS X Mountain Lion, Dictionary Development Kit required to build dictionaries is not included by default with developer tools.
Dictionary Development Kit can be downloaded from [Downloads for Apple Developers](https://developer.apple.com/downloads/index.action) page and it is inside **Auxiliary Tools for Xcode** package. You must copy `Dictionary Development Kit` manually to `/Developer/Extras` folder.
## Install
gem install rubydictionary
## Building dictionary
Run `rubydictionary` in your source code directory. For example for source of Sinatra:
rubydictionary \
--dict-name=Sinatra \
--dict-id=com.sinatrarb.Dictionary
If everything goes well, you should now have `Sinatra.dictionary` file under `./doc/objects` directory. Drop it into `~/Library/Dictionaries/` folder.
If Dictionary Development Kit is located somewhere else than in `/Developer/Extras` (which is recommended in 10.9+), you can specify the path for it with `--kit-path` option:
rubydictionary \
--dict-name=Sinatra \
--dict-id=com.sinatrarb.Dictionary \
--kit-path=~/Source/DictionaryDevKit
## Authors
See the [Github contributors page](https://github.com/priithaamer/rubydictionary/contributors).
## Links
* [Dictionary Services programming guide at Apple Developer site](http://developer.apple.com/library/mac/documentation/UserExperience/Conceptual/DictionaryServicesProgGuide/index.html)
* [https://github.com/breakpointer/ajax-rdoc](https://github.com/breakpointer/ajax-rdoc)