diff options
Diffstat (limited to 'docs/index.html')
| -rw-r--r-- | docs/index.html | 110 |
1 files changed, 110 insertions, 0 deletions
diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..9e557ac --- /dev/null +++ b/docs/index.html @@ -0,0 +1,110 @@ +<!DOCTYPE html> +<html> + <head> + <meta charset="UTF-8"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<title> + File: README + + — Documentation by YARD 0.9.26 + +</title> + + <link rel="stylesheet" href="css/style.css" type="text/css" /> + + <link rel="stylesheet" href="css/common.css" type="text/css" /> + +<script type="text/javascript"> + pathId = "README"; + relpath = ''; +</script> + + + <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="js/app.js"></script> + + + </head> + <body> + <div class="nav_wrap"> + <iframe id="nav" src="class_list.html?1"></iframe> + <div id="resizer"></div> + </div> + + <div id="main" tabindex="-1"> + <div id="header"> + <div id="menu"> + + <a href="_index.html">Index</a> » + <span class="title">File: README</span> + +</div> + + <div id="search"> + + <a class="full_list_link" id="class_list_link" + href="class_list.html"> + + <svg width="24" height="24"> + <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> + <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> + <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> + </svg> + </a> + +</div> + <div class="clear"></div> + </div> + + <div id="content"><div id='filecontents'><h1 id="felpack-r2d-bindings">Felpack::R2d::Bindings</h1> + +<p>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 <code>lib/felpack/r2d/bindings</code>. To experiment with that code, run <code>bin/console</code> for an interactive prompt.</p> + +<p>TODO: Delete this and the text above, and describe your gem</p> + +<h2 id="installation">Installation</h2> + +<p>Add this line to your application's Gemfile:</p> + +<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>felpack-r2d-bindings</span><span class='tstring_end'>'</span></span> +</code></pre> + +<p>And then execute:</p> + +<pre class="code ruby"><code class="ruby">$ bundle install +</code></pre> + +<p>Or install it yourself as:</p> + +<pre class="code ruby"><code class="ruby">$ gem install felpack-r2d-bindings +</code></pre> + +<h2 id="usage">Usage</h2> + +<p>TODO: Write usage instructions here</p> + +<h2 id="development">Development</h2> + +<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p> + +<p>To install this gem onto your local machine, run <code>bundle exec rake install</code>. To release a new version, update the version number in <code>version.rb</code>, and then run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and the created tag, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</p> + +<h2 id="contributing">Contributing</h2> + +<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/%5BUSERNAME%5D/felpack-r2d-bindings">https://github.com/[USERNAME]/felpack-r2d-bindings</a>.</p> + +<h2 id="license">License</h2> + +<p>The gem is available as open source under the terms of the <a href="https://opensource.org/licenses/MIT">MIT License</a>.</p> +</div></div> + + <div id="footer"> + Generated on Fri Jul 9 20:40:14 2021 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.9.26 (ruby-2.7.3). +</div> + + </div> + </body> +</html>
\ No newline at end of file |