Skip to content

Commit

Permalink
Documentation: Consistency: Mention CONFIG_DIR default, legacy locati…
Browse files Browse the repository at this point in the history
…on for completion

Add a note that the legacy locations (now also consistently used for the completion script) are not recommended, just to illustrate how to override the default locations.
  • Loading branch information
inkarkat committed Dec 29, 2024
1 parent d5d6ee7 commit e92d64f
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,13 @@ make test

*NOTE:* Makefile defaults to several default paths for installed files. Adjust to your system:

- `INSTALL_DIR`: PATH for executables (default /usr/local/bin)
- `CONFIG_DIR`: PATH for the todo.txt configuration template
- `INSTALL_DIR`: PATH for executables (default `/usr/local/bin`)
- `CONFIG_DIR`: PATH for the `todo/config` configuration template (default `/usr/local/etc`)
- `BASH_COMPLETION`: PATH for autocompletion scripts (default to `/usr/local/share/bash-completion/completions`)

```shell
make install CONFIG_DIR=/etc INSTALL_DIR=/usr/bin BASH_COMPLETION=/usr/share/bash-completion/completions
# Note: Showcasing config overrides for legacy locations; NOT recommended!
make install CONFIG_DIR=/etc INSTALL_DIR=/usr/bin BASH_COMPLETION=/etc/bash_completion.d
```

#### Arch Linux (AUR)
Expand Down

0 comments on commit e92d64f

Please sign in to comment.