Skip to content

r6e/geode-rb

Repository files navigation

DISCLAIMER: This gem is not published, and may not even work at times.

This gem, and all other "Geode" projects authored by r6e are inteded as a way to try out and practice new languages/libraries/techniques. Due to this, there are currently no plans to publish these, no guarantee that they work at all, and do not necessarily reflect high coding standards or best-practices.

Geode: a gem for geometric calculations on planets

Geode provides an easy way to work with points, vectors, and shapes on the surface of planets (currently, only Earth is included by default).

Installation

Add this line to your application's Gemfile:

gem 'geode'

And then execute:

$ bundle

Or install it yourself as:

$ gem install geode

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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.

Contributing

Bug reports and pull requests are welcome on GitLab at https://gitlab.com/redapted/geode. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Geode project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

A gem for geometric calculations on planets

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published