bug-fork

fork/re-write of bug cli todo manager
git clone https://git.regexghost.com/bug-fork.git
Log | Files | Refs | README | LICENSE

README.md (1252B)

      1 # bug
      2 
      3 This is my fork/rewrite of bug, an obscure cli todo manager I found on the internet
      4 
      5 [Link to the original bug](https://viric.name/soft/bug/index.html)
      6 
      7 ## My Changes
      8 
      9 * Now uses `/bin/sh` instead of `bash`
     10 * Input basic info with `read`, so you don't have to navigate around a text file
     11 * Coloured output
     12 * Sorting by priority
     13 * Interactive selection using `fzf`, instead of specifying ID
     14 * Deletion only moves to another file, allowing recovery
     15 
     16 ## Screenshots
     17 
     18 ![bug ls](bug-ls.jpg)
     19 
     20 ![bug view](bug-view.jpg)
     21 
     22 ## Dependencies
     23 
     24 * `fzf`
     25 
     26 ## Install
     27 
     28 ```
     29 git clone https://github.com/regexghost/bug-fork
     30 cd bug-fork
     31 make install
     32 ```
     33 
     34 Add `BUG_PROJECT=${HOME}/*location*` to `~/.profile` or `~/.bashrc`  
     35 e.g. `echo 'BUG_PROJECT="${HOME}/Documents/bug-todo"' >> ~/.bashrc`
     36 
     37 ## Usage
     38 
     39 `man bug` to see full usage guide
     40 
     41 ### Commands
     42 
     43 `bug list` - List all active todos  
     44 `bug view` - View details for a specific todo - uses `fzf` to select  
     45 `bug add` - Add new todo  
     46 `bug edit` - Edit specific todo - uses `fzf`  
     47 `bug delete` - Delete specific todo - uses `fzf`  
     48 `bug restore` - Restore deleted todo - uses `fzf`  
     49 `bug version` - Show version  
     50 `bug create` - Initalise project file  
     51 `bug project` - Print project file  
     52 
     53 ## License
     54 
     55 GPL 2