adhered to the all-powerful spelling of to-do, rather than the spelling of todo

main
m455 2019-07-11 19:45:53 -04:00
parent 9e0d2208ef
commit 9abb50b9bd
4 changed files with 18 additions and 23 deletions

View File

@ -1,12 +1,6 @@
# rodo # rodo
A easy-to-use todo list program for people who live on the command line. A easy-to-use to-do list program for people who live on the command line.
Also available from the following Git-hosting services:
* https://github.com/m455/rodo
* https://gitlab.com/m455/rodo
* https://notabug.org/m455/rodo
# Screenshot # Screenshot
@ -16,7 +10,7 @@ Also available from the following Git-hosting services:
- [TL;DR](#tldr) - [TL;DR](#tldr)
- [New features](#new-features) - [New features](#new-features)
- [Todos](#todos) - [To-dos](#to-dos)
- [Platforms](#platforms) - [Platforms](#platforms)
- [Installing rodo](#installing-rodo) - [Installing rodo](#installing-rodo)
- [Requirements](#requirements) - [Requirements](#requirements)
@ -59,15 +53,15 @@ Now the default directory and todo list file have better default permissions:
* `rodo` is now licensed under AGPL3! * `rodo` is now licensed under AGPL3!
* `~/.rodo/` is set to 700 by default * `~/.rodo/` is set to 700 by default
* `~/.rodo/todo.txt` is set to 600 by default. * `~/.rodo/to-do.txt` is set to 600 by default.
# Todos # To-dos
When I have time, I plan on adding the following features to rodo: When I have time, I plan on adding the following features to rodo:
- Add a purpose, context, and overview for each h1 in `README.md` - Add a purpose, context, and overview for each h1 in `README.md`
- A boolean color option in the `config.rkt` file - A boolean color option in the `config.rkt` file
- Encrypt/decrypt `todo.txt` file - Encrypt/decrypt `to-do.txt` file
# Platforms # Platforms
@ -78,6 +72,7 @@ Below is a list of platforms that `rodo` can run on.
* macOS (Untested) * macOS (Untested)
# Installing rodo # Installing rodo
This section will guide you through installing `rodo`, so you can use it on your platform. This section will guide you through installing `rodo`, so you can use it on your platform.
## Requirements ## Requirements
@ -172,10 +167,10 @@ raco exe rodo.rkt
This section lists and describes `rodo`'s commands. This section lists and describes `rodo`'s commands.
* `-h` or `--help` displays the help message * `-h` or `--help` displays the help message
* `init` creates a file called `todo.txt` in `~/.rodo/` by default * `init` creates a file called `to-do.txt` in `~/.rodo/` by default
* `ls` displays numbered items in the todo list * `ls` displays numbered items in the to-do list
* `add` adds an item to the todo list * `add` adds an item to the to-do list
* `rm` removes an item from the todo list * `rm` removes an item from the to-do list
Note: You may have to run `rodo ls` to see which number corresponds to which item when removing items. Note: You may have to run `rodo ls` to see which number corresponds to which item when removing items.
@ -195,7 +190,7 @@ The examples below assume that you have [added `rodo` to your `$PATH`](https://g
`rodo add this is a task without quotes` `rodo add this is a task without quotes`
`rodo rm 1` (This removes the first item in your list) `rodo rm 1` (This removes the first item in your to-do list)
Note: You may have to run `rodo ls` to see which number corresponds to which item when removing items. Note: You may have to run `rodo ls` to see which number corresponds to which item when removing items.

View File

@ -3,7 +3,7 @@
(define program-name "rodo") (define program-name "rodo")
(define program-directory (path->string (expand-user-path "~/.rodo/"))) (define program-directory (path->string (expand-user-path "~/.rodo/")))
(define program-file "todo.txt") (define program-file "to-do.txt")
(define remove-command "rm") (define remove-command "rm")
(define add-command "add") (define add-command "add")
(define list-command "ls") (define list-command "ls")

View File

@ -28,7 +28,7 @@
"Create a file in " "Create a file in "
config:program-directory config:program-directory
config:program-file config:program-file
" where your todo list will be stored\n" " where your to-do list will be stored\n"
"Example:\n" "Example:\n"
config:program-name " " config:program-name " "
config:initialize-command "\n" config:initialize-command "\n"
@ -77,7 +77,7 @@
"to scroll up and down through the help message, then when you " "to scroll up and down through the help message, then when you "
"want to quit, just type `q` (without the grave accents)\n") "want to quit, just type `q` (without the grave accents)\n")
'empty-todo-list "> There is nothing in your list \n" 'empty-to-do-list "> There is nothing in your list \n"
'show-usage (string-append 'show-usage (string-append
"> For usage type " "> For usage type "

View File

@ -29,10 +29,10 @@
(display (hash-ref hash-list key))) (display (hash-ref hash-list key)))
(define (file->string-list config:path-to-file-to-file) (define (file->string-list config:path-to-file-to-file)
(let ([todo-list (file:file->lines config:path-to-file-to-file (let ([to-do-list (file:file->lines config:path-to-file-to-file
#:mode 'text #:mode 'text
#:line-mode 'any)]) #:line-mode 'any)])
todo-list)) to-do-list))
(define (list-empty? lst) (define (list-empty? lst)
(list:empty? (file->string-list lst))) (list:empty? (file->string-list lst)))
@ -85,7 +85,7 @@
(check-for-program-file)) (check-for-program-file))
(if (if
(list-empty? config:path-to-file) (list-empty? config:path-to-file)
(display-hash-ref messages:messages 'empty-todo-list) (display-hash-ref messages:messages 'empty-to-do-list)
(display-prettified-program-file))] (display-prettified-program-file))]
[else [else
(display-hash-ref messages:messages 'file-not-found) (display-hash-ref messages:messages 'file-not-found)
@ -124,7 +124,7 @@
(define (remove-item-from-list args) (define (remove-item-from-list args)
(cond [(list-empty? config:path-to-file) (cond [(list-empty? config:path-to-file)
(display-hash-ref messages:messages 'empty-todo-list)] (display-hash-ref messages:messages 'empty-to-do-list)]
[(and (check-for-program-directory) [(and (check-for-program-directory)
(check-for-program-file)) (check-for-program-file))
(remove-item-from-program-file (vector-ref args 1))] (remove-item-from-program-file (vector-ref args 1))]