From 9abb50b9bd892707edf2671b6a1be85d22849da7 Mon Sep 17 00:00:00 2001 From: m455 Date: Thu, 11 Jul 2019 19:45:53 -0400 Subject: [PATCH] adhered to the all-powerful spelling of to-do, rather than the spelling of todo --- README.md | 27 +++++++++++---------------- config.rkt | 2 +- messages.rkt | 4 ++-- util.rkt | 8 ++++---- 4 files changed, 18 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 3403f09..f79594f 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,6 @@ # rodo -A easy-to-use todo 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 +A easy-to-use to-do list program for people who live on the command line. # Screenshot @@ -16,7 +10,7 @@ Also available from the following Git-hosting services: - [TL;DR](#tldr) - [New features](#new-features) -- [Todos](#todos) +- [To-dos](#to-dos) - [Platforms](#platforms) - [Installing rodo](#installing-rodo) - [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 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: - Add a purpose, context, and overview for each h1 in `README.md` - A boolean color option in the `config.rkt` file -- Encrypt/decrypt `todo.txt` file +- Encrypt/decrypt `to-do.txt` file # Platforms @@ -78,6 +72,7 @@ Below is a list of platforms that `rodo` can run on. * macOS (Untested) # Installing rodo + This section will guide you through installing `rodo`, so you can use it on your platform. ## Requirements @@ -172,10 +167,10 @@ raco exe rodo.rkt This section lists and describes `rodo`'s commands. * `-h` or `--help` displays the help message -* `init` creates a file called `todo.txt` in `~/.rodo/` by default -* `ls` displays numbered items in the todo list -* `add` adds an item to the todo list -* `rm` removes an item from the todo list +* `init` creates a file called `to-do.txt` in `~/.rodo/` by default +* `ls` displays numbered items in the to-do list +* `add` adds an item to the to-do 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. @@ -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 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. diff --git a/config.rkt b/config.rkt index b2f698b..b5ac1fd 100644 --- a/config.rkt +++ b/config.rkt @@ -3,7 +3,7 @@ (define program-name "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 add-command "add") (define list-command "ls") diff --git a/messages.rkt b/messages.rkt index c2813b2..026cb52 100644 --- a/messages.rkt +++ b/messages.rkt @@ -28,7 +28,7 @@ "Create a file in " config:program-directory config:program-file - " where your todo list will be stored\n" + " where your to-do list will be stored\n" "Example:\n" config:program-name " " config:initialize-command "\n" @@ -77,7 +77,7 @@ "to scroll up and down through the help message, then when you " "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 "> For usage type " diff --git a/util.rkt b/util.rkt index 432f2c7..374b4fc 100644 --- a/util.rkt +++ b/util.rkt @@ -29,10 +29,10 @@ (display (hash-ref hash-list key))) (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 #:line-mode 'any)]) - todo-list)) + to-do-list)) (define (list-empty? lst) (list:empty? (file->string-list lst))) @@ -85,7 +85,7 @@ (check-for-program-file)) (if (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))] [else (display-hash-ref messages:messages 'file-not-found) @@ -124,7 +124,7 @@ (define (remove-item-from-list args) (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) (check-for-program-file)) (remove-item-from-program-file (vector-ref args 1))]