noozoid/README.md

48 lines
985 B
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).
2021-01-02 21:39:13 +00:00
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:
2019-12-29 11:59:14 +00:00
## Installation
2021-01-02 21:39:13 +00:00
Make sure you have the latest version of crystal (0.35.x)
Build the project
2019-12-29 11:59:14 +00:00
2021-01-02 21:39:13 +00:00
$ make build
2019-12-29 11:59:14 +00:00
## Usage
2019-12-29 21:48:11 +00:00
### Running noozoid
In your terminal:
2021-01-02 21:39:13 +00:00
$ _build/noozoid
2019-12-29 21:48:11 +00:00
### Keyboard control
| Key | Description |
|---|--|
| h | Navigate to parent |
| l | Navigate to child |
| k | Navigate to previous sibling |
| j | Navigate to next sibling |
| r | Navigate to tree root |
| c | Create node |
| d | Delete selected node |
| v | Toggle node |
| ? | Show this help |
| q | Exit program |
2019-12-29 11:59:14 +00:00
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/glenux/noozoid.