commit 8d54d929fcd63f1597af2b72c4bbd4b880d05427
Author: Jake Bauer <jbauer@paritybit.ca>
Date: Wed, 6 Oct 2021 02:30:41 -0400
Initial commit
Diffstat:
| A | LICENSE | | | 15 | +++++++++++++++ |
| A | README.md | | | 49 | +++++++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 64 insertions(+), 0 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2021, Jake Bauer
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,49 @@
+# Taskurse
+
+Taskurse is a simple, ncurses-based tool to interact with a task list.
+
+The name is a portmanteau of "task" and "curse" (from "ncurses"). It is
+pronounced like tas-curse or /'tæs.kɝs/.
+
+## Motivation
+
+I wanted a simple tool that would let me visualize a list of tasks to complete
+on my PC (I would normally use pen and paper for this). Unfortunately, it seems
+that almost every tool wants to be an all-in-one task
+management+scheduler+reminder tool or seems to be written in a very bloated
+language and I simply don't need such complexity.
+
+My most common usecase for this tool is to keep a list of what needs to get done
+when I am programming or writing blog posts. For example, I can make a list of
+features to implement in a file, and run `taskurse features.txt` in a terminal
+to allow me to very easily manage that list in a more visually pleasing format
+than having the file open in Vim or Emacs and using a macro.
+
+I wanted to create a tool that could do a few simple things, outlined below:
+
+## Features
+
+* Simple text-based task file
+ - One task per line
+ - Line starts with `x ` if task complete
+ - Content of the line is the content of the task
+* Ability to mark/unmark tasks as complete in the UI
+* Ability to insert items to the list
+* Ability to delete items from the list
+* List auto-saves after every action
+* Easy-to-use UI with keybindings displayed on-screen
+ - h,j,k,l and arrow keys for navigation
+ - spacebar to mark/unmark tasks as complete
+ - q,^C to quit the program
+* Very simple command-line usage: `taskurse <file>` is all you need
+
+## Installing
+
+Instructions coming soon.
+
+## Contributing
+
+Feel free to send your patches to ${MAILING_LIST_COMING_SOON}. If you want to
+introduce a new feature but I don't feel that it fits with my goals for this
+project, please feel free to fork this project and mould it to your needs.
+That's what FOSS is about, after all.
