Skip to content

Update README.md #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
smkent merged 2 commits into from
May 23, 2026
Merged

Update README.md #63

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6fd1b78
Update ctags package name reference
smkent May 23, 2026
aadd3b2
Fix `dotf` hyperlinks
smkent May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ $ git checkout .
### Configuration

To configure your git email address and username to be hidden from shell
prompts, run `[dotf](/.dotfiles/bin/dotf) config`.
prompts, run [`dotf config`][dotf].

To use a different profile picture, remove or replace `.face`.

Expand All @@ -55,13 +55,13 @@ More features become available when optional dependencies are installed:
[ALE](https://github.com/dense-analysis/ale))
* `ctags` (for
[vim-gutentags](https://github.com/ludovicchabant/vim-gutentags),
typically available as the `exuberant-ctags` package)
typically available as the `universal-ctags` package)
* `xclip` (for copying to the system clipboard in tmux)
* [terminal_markdown_viewer](https://github.com/axiros/terminal_markdown_viewer)
(for previewing Markdown files with
[vim-pipe-preview](https://github.com/smkent/vim-pipe-preview))

Run `[dotf](/.dotfiles/bin/dotf) deps` to see the executable path and version
Run [`dotf deps`][dotf] to see the executable path and version
information for programs that this repository configures or depends on.

## Features
Expand All @@ -74,7 +74,7 @@ with zsh on OS X.
Prompt features:

* Display username if different from the value of `prompt_hide_user` configured
via `[dotf](/.dotfiles/bin/dotf) config`.
via [`dotf config`][dotf].
* Display current directory name if different from `${HOME}`
* Display exit code of the previous command if nonzero (or `bg` / `^C` when
backgrounding a job or typing Ctrl-C, respectively)
Expand Down Expand Up @@ -254,5 +254,6 @@ Original code in this repository is published under the MIT license. See
[`.dotfiles/doc/LICENSE`](/.dotfiles/doc/LICENSE) for licensing information.


[dotf]: /.dotfiles/bin/dotf
[prek]: https://prek.j178.dev/
[uv-tool]: https://docs.astral.sh/uv/guides/tools/