Update README with latest info

This commit is contained in:
Glenn Y. Rolland 2021-01-02 22:39:13 +01:00
parent bd8ad00026
commit 56cb767368

View file

@ -4,11 +4,16 @@ A terminal-based mindmap editor for geeks.
The name of the project comes from the Greek words _νους_ (mind) and ούδι_ (small animal).
For now, It is a toy project to improve author's skills with the language and its various libraries. **It is very early stage and is not supposed to work (yet). Please don't use it in production.** :warning:
## Installation
Type the following line in your favorite terminal:
Make sure you have the latest version of crystal (0.35.x)
$ gem install noozoid
Build the project
$ make build
## Usage
@ -16,7 +21,7 @@ Type the following line in your favorite terminal:
In your terminal:
$ noozoid [gui]
$ _build/noozoid
### Keyboard control
@ -34,21 +39,9 @@ In your terminal:
| q | Exit program |
## 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>