gobang/README.md
Takayuki Maeda 07b2b5090f
Add key config (#33)
* implement key config

* use key config in help component

* use key config in databases component

* use key config in error component

* use key config in connections component

* set commands

* use database/table as a table component name

* fix a test for get_text

* use key config in tab component

* fix function name

* add focus_connections key

* use quit exit key
2021-08-01 01:03:39 +09:00

40 lines
1.0 KiB
Markdown

<div align="center">
# gobang
gobang is currently in alpha
A cross-platform terminal database tool written in Rust
[![github workflow status](https://img.shields.io/github/workflow/status/TaKO8Ki/gobang/CI/main)](https://github.com/TaKO8Ki/gobang/actions) [![crates](https://img.shields.io/crates/v/gobang.svg?logo=rust)](https://crates.io/crates/gobang)
![gobang](./resources/gobang.gif)
</div>
## Features
- Cross-platform support (macOS, Windows, Linux)
- Multiple Database support (MySQL PostgreSQL, SQLite)
- Intuitive keyboard only control
## Installation
### Cargo
If you already have a Rust environment set up, you can use the `cargo install` command:
```
$ cargo install --version 0.1.0-alpha.0 gobang
```
## Keymap
| Key | Description |
| ---- | ---- |
| <kbd>h</kbd> | scroll left |
| <kbd>j</kbd> | scroll down |
| <kbd>k</kbd> | scroll up |
| <kbd>l</kbd> | scroll right |
| <kbd>Ctrl</kbd> + <kbd>d</kbd> | scroll down multiple lines |
| <kbd>Ctrl</kbd> + <kbd>u</kbd> | scroll up multiple lines |