Skip to content

gsobell/percentual

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

percentual

a nCurses progress tracker

screenshot of v0.1.0

About

percentual is:

  • a progress tracker

percentual is not:

  • a TODO list (see vit)
  • a habit tracker (see dijo)

Usage

Installation

To install in the current working directory on any *nix system:

curl -LO  https://raw.githubusercontent.com/gsobell/percentual/home/percentual.py
mv percentual.py percentual && chmod +x percentual

To install on Arch and derivative systems, use the PKGBUILD:

curl -O https://raw.githubusercontent.com/gsobell/percentual/home/PKGBUILD
makepkg -i

To add a new item to track:

percentual [name] [total sections] [optional = current section]

For example, if you were reviewing a textbook, and you read until chapter 14:

percentual Intro-to-Algo 35 14

Controls

Add new item as argument to Use vim or arrow keys to navigate the list of items. Use the left or right (h or l) to increment by 1. Press q anytime to exit.

Features

Current

  • Add item and steps to completion
  • Sane defaults
  • User defined color palette
  • Data stored in XDG directory, in json

Future

  • Checklist functionality
  • Term-resize resilience
  • Vim-style command palette
  • Delete from within UI
  • Roman, 1a, or SemVer numbering
  • Multiple separate panels

Like progress, but for humans.