Skip to content

thegriglat/Quest

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Just

a simple todo list terminal user interface Demo

Built With

Getting Started

Steps to install and run the application in your terminal.

Prerequisites

Installation

not available yet

  • cargo install quest-tui

Building Locally

Clone the project then:

  • cargo build to build iit
  • cargo run to run it directly

Usage

after installing with cargo, you can run the command quest-tui

Configuration

Quest uses directories-next to save configuration and data files, config directory:

  • Linux: $XDG_CONFIG_HOME/quest or $HOME/.config/quest
  • Windows: {FOLDERID_RoamingAppData}/quest/config
  • macOS: $HOME/Library/Application Support/quest A config file is created if one does not exists already when you run the app.

default configs:

{
    "colors": {
      "foreground": "White",
      "background": "Black",
      "selection_fg": "Black",
      "selection_bg": "Yellow",
      "check_sign": "Green"
    },
    "keybindings": {
      "exit_app": "Esc",
      "new_quest": {
        "Char": "n"
      },
      "check_and_uncheck_quest": "Enter",
      "list_up": "Up",
      "list_down": "Down",
      "delete_quest": "Delete",
      "exit_adding": "Esc",
      "save_quest": "Enter"
    }
}

You can refer to Color and Keybinding for all possible configs.

Example keybindings

Vi

  "keybindings": {
    "exit_app": {
      "Char": "z"
    },
    "new_quest": {
      "Char": "n"
    },
    "check_and_uncheck_quest": {
      "Char": "c"
    },
    "list_up": {
      "Char": "k"
    },
    "list_down": {
      "Char": "j"
    },
    "delete_quest": {
      "Char": "x"
    },
    "exit_adding": "Esc",
    "save_quest": "Enter"

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. guide

Authors

Acknowledgments

License

Distributed under the MIT License. See LICENSE for more information.

About

Rust Todo TUI

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 100.0%