diff options
| author | Seba Gamboa <[email protected]> | 2015-09-23 16:29:46 -0300 |
|---|---|---|
| committer | Seba Gamboa <[email protected]> | 2015-09-23 16:29:46 -0300 |
| commit | 9f17c636bb322eaceabd3b4e5a13d730acd622f4 (patch) | |
| tree | 5df2452ce5c75ea685889fe1599a9e3e267540b6 /README.md | |
| parent | 2eedb9b4b407778609b261a7e42773f5885da01e (diff) | |
| download | yard-mruby-9f17c636bb322eaceabd3b4e5a13d730acd622f4.tar.gz yard-mruby-9f17c636bb322eaceabd3b4e5a13d730acd622f4.zip | |
Updated README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 16 insertions, 18 deletions
@@ -1,38 +1,36 @@ -# Yard::Mruby +# yard-mruby + +This is a plugin that allows YARD to parse and generate documentation for MRuby sources. +It handles the different C API Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yard/mruby`. To experiment with that code, run `bin/console` for an interactive prompt. TODO: Delete this and the text above, and describe your gem -## Installation - -Add this line to your application's Gemfile: - -```ruby -gem 'yard-mruby' -``` - -And then execute: - - $ bundle +## Usage -Or install it yourself as: +Install with rubygems $ gem install yard-mruby -## Usage +Configure your project's `.yardopts` + +``` +--plugin mruby +mrblib/**/*.rb +src/**/*.c +``` -TODO: Write usage instructions here +And execute `yardoc` to generate the docs ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. - -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). +To install this gem onto your local machine, run `bundle exec rake install`. ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yard-mruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcome on GitHub at https://github.com/sagmor/yard-mruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. ## License |