🟠 Draft | A terminal-based mindmap editor for geeks.

Find a file

Glenn Y. Rolland 63a8289b45 Update README.md		2021-01-03 07:15:35 +01:00
.github/workflows	CI/CD: lowercase workflow name	2021-01-03 06:51:42 +01:00
doc	Add doc directory	2021-01-03 07:12:16 +01:00
spec	Reorganize spec tree	2021-01-03 06:49:51 +01:00
src	Add basic window management code for NCurses.cr	2021-01-02 22:36:55 +01:00
.gitignore	Add doc directory	2021-01-03 07:12:16 +01:00
Dockerfile	Add Dockerfile	2021-01-03 06:49:38 +01:00
LICENSE.txt	Add license file	2021-01-02 22:52:40 +01:00
Makefile	Add basic specs	2021-01-03 06:14:01 +01:00
README.md	Update README.md	2021-01-03 07:15:35 +01:00
shard.lock	Update shards.lock	2021-01-02 16:23:56 +01:00
shard.yml	Switch from ruby to crystal	2021-01-02 14:49:56 +01:00

README.md

Noozoid

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. ⚠️

Installation

Make sure you have the latest version of crystal (0.35.x)

Build the project

$ make build

Usage

Running noozoid

In your terminal:

$ _build/noozoid

Keyboard control (vim-like)

NORMAL mode

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
i	Enter EDIT mode for current node
d	Delete/Cut selected node
p	Paste node as a child of selected node
v	Toggle node
?	Show this help
:	Enter COMMAND mode

COMMAND mode

Command	Description
w	Write file
e	Load file
q	Exit program
ESC	Go to normal mode

EDIT mode

Command	Description
ESC	Go to normal mode

Any other key will be written as the content selected node.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/glenux/draft-noozoid.