~sschwarzer/todo-txt

1da3709b5f057eb2d541aeffd2e852df2c1c7757 — Stefan Schwarzer 8 months ago 707dccf main
Improve README.md

- Make some wording clearer
- Fix Markdown formatting
1 files changed, 27 insertions(+), 22 deletions(-)

M README.md
M README.md => README.md +27 -22
@@ 33,36 33,41 @@ No context

## Installation

### Racket library
### If you want to use the Racket library

1. Install Racket, if not already installed

   https://download.racket-lang.org/ has up-to-date installation
   files, but you can also install Racket with a package manager if
   you're using Linux/Unix.
     https://download.racket-lang.org/ has up-to-date installation
     files, but you can also install Racket with a package manager if
     you're using Linux/Unix.

2. 
   - On the command line, type
     ```
     raco pkg install todo-txt
     ```
2. Then use any of these three methods:

   - To install the tool from the Git repository, use
     ```
     raco pkg install git+https://git.sr.ht/~sschwarzer/todo-txt#v0.1
     ```
     possibly with a different tag. The `git+https` protocol requires
     at least Racket 8.1.
       - On the command line, type

   - Clone the Git repo and from inside the Git working directory run
     ```
     raco pkg install
     ```
         ```
         raco pkg install todo-txt
         ```

       - To install the tool from the Git repository, use

         ```
         raco pkg install git+https://git.sr.ht/~sschwarzer/todo-txt#v0.1
         ```

         possibly with a different tag. The `git+https` protocol requires
         at least Racket 8.1.

       - Clone the Git repo and from inside the Git working directory run

         ```
         raco pkg install
         ```

### Just the `todoreport` tool

If you don't need the `todo-txt` _library_ and just want the `todoreport` tool
(described below), download binaries from
(introduced above and described in more detail below), download binaries from
<https://releases.sschwarzer.net/todo-txt>.




@@ 168,8 173,8 @@ sort spec, and so on. Check the example at the beginning of this file.
In case of a tie (say, you sort only by priority and some tasks have
the same priority), the original order from the file is kept.

Note that if you specify multiple sort specs, separate them with a
*comma*, but *don't* put a space after the comma.
Note that if you specify multiple group specs and/or sort specs, separate them
with a *comma*, but *don't* put a space after the comma.

The `--group-by` and/or `--sort-by` options are optional. If neither
option is used, the tasks will be displayed in the order they appear