nCurses ToDo

A simple, lightweight todo list creation/management application
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • Keybinds
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

ntd is a simple, lightweight todo list creation/management application. It boasts a very clean, minimal terminal user interface (TUI). The program is written in C and uses the nCurses library to handle the TUI.

(back to top)

Built With

• nCurses

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• nCurses
• cMake

These are very common packages, and can be easily googled to find the command to install them on your distribution of linux.

Installation

1. Clone the repo

   git clone https://github.com/prestonbridgers/ntd.git
   cd ntd

2. Create a build directory

   mkdir build && cd build

3. Compile the program with cMake

   cmake -S ../src -B .
   cmake --build .

4. Run the program

   ./ntd [filename]

(back to top)

Usage

ntd [filename]
  filename - Optional filename from/to which to load/save todo list entries (default: todo.txt)

The program currently supports the following features:

• Loading/saving a todo list from/to a file.
• Adding/deleting entries
• Marking entries as complete/incomplete

Running the program without arguments automatically creates a todo.txt file in the current directory. On exit, the list is saved to that same file.

To add/delete/mark an entry, press the appropriate key, type the number assigned to the entry, and press Enter.

An attempt to delete or mark an entry number that doesn't exist, nothing will happen and you will be returned to the delete/mark window will close.

Keybinds

q -> Quits the program
a -> Opens the add entry menu
d -> Opens the delete entry menu
m -> Opens the mark entry menu

(back to top)

Roadmap

• Allow the user to specify file in which to save the list
• [] Add date field to the entries
• Switch to the cmake build system for some sense of portability
• Add support for multiple todo lists
  • [] Add menu for selecting todo list on startup and keypress (maybe 't')
  • [] Add a list of directories in which to look for todo lists

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Preston Bridgers - [email protected]

Project Link: https://github.com/prestonbridgers/ntd

(back to top)