noozoid/README.md

36 lines
1 KiB
Markdown
Raw Normal View History

2019-12-29 11:59:14 +00:00
# Noozoid
A terminal-based mindmap editor for geeks.
The name of the project comes from the Greek words _νους_ (mind) and ούδι_ (small animal).
## Installation
Type the following line in your favorite terminal:
$ gem install noozoid
## Usage
TODO: Write usage instructions here
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/glenux/noozoid.
## References
* <https://stac47.github.io/ruby/curses/tutorial/2014/01/21/ruby-and-curses-tutorial.html>