From 9bd202b2754f9f37e7047599035befe2954027af Mon Sep 17 00:00:00 2001 From: Sem van der Hoeven Date: Sun, 6 Sep 2020 19:48:35 +0200 Subject: [PATCH] added controls to readme --- console-gui.py | 11 ++++++----- readme.md | 17 ++++++++++++++++- 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/console-gui.py b/console-gui.py index 2618425..33dc419 100644 --- a/console-gui.py +++ b/console-gui.py @@ -19,7 +19,7 @@ WHITE_CYAN = 11 FILENAME = "data" menu_width = 27 -controls_lines = 8 +controls_lines = 9 editing = False @@ -476,10 +476,11 @@ def draw_instructions(stdscr): stdscr.addstr(instructions_start + 1, 0, "UP/DOWN - Move selection") stdscr.addstr(instructions_start + 2, 0, "LEFT/RIGHT - Switch section") stdscr.addstr(instructions_start + 3, 0, "SPACE - Change task status") - stdscr.addstr(instructions_start + 4, 0, "p - Add new project") - stdscr.addstr(instructions_start + 5, 0,"t - Add new task to project") - stdscr.addstr(instructions_start + 6, 0,"DEL - Delete selected item") - stdscr.addstr(instructions_start + 7, 0,"q - Quit") + stdscr.addstr(instructions_start + 4, 0, "DEL - Delete selected item") + stdscr.addstr(instructions_start + 5, 0, "p - Add new project") + stdscr.addstr(instructions_start + 6, 0, "t - Add new task to project") + stdscr.addstr(instructions_start + 7, 0, "r - rename selected item") + stdscr.addstr(instructions_start + 8, 0, "q - Quit") diff --git a/readme.md b/readme.md index af412a2..d99f881 100644 --- a/readme.md +++ b/readme.md @@ -21,5 +21,20 @@ It gives a neat presentation of all your projects, which you can assign tasks to Download the file from the [releases page](https://github.com/SemvdH/terminal-project-management/releases) and run `python console-gui.py` # Usage -https://github.com/lukesampson/scoop/wiki/Creating-an-app-manifest +The tool is made to be used in a side window, preferably half the size of your screen, but it works in all +window sizes. +The application is navigated using the arrow keys and certain shortcut keys. The controls are also listed at the bottom of the application: +![controls image](controls.png) + + - up / down arrow - move selection + - this selects a different project or task + - left / right arrow - switch section + - this switches between selecting tasks or projects + - space - change task status + - there are 4 states a task can be in: Done, Idle, Working and no state. By default all newly added tasks are in No state but you can cycle through these using the space bar. + - delete key - deletes selected project or task. + - p - adds a new project + - t - adds a new task to the currently selected project + - r - rename selected project or task + - q - exit the application