Skip to content
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

Update completion path in README.md #385

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update completion path in README.md #385

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,8 @@ users, so let's start with that.

```
mkdir -p $ZSH_CUSTOM/plugins/tldr
ln -s bin/completion/zsh/_tldr $ZSH_CUSTOM/plugins/tldr/_tldr
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This path assumes you have a local clone of the codebase. But maybe that wasn't clear. I'd like to keep both versions of this. Maybe we can clarify and say that if you have a local clone of the repo, use bin/completion/zsh/_tldr or else use $(npm config get prefix)/lib/node_modules/tldr/bin/completion/zsh/_tldr once you have installed the tool?

ln -s $(npm config get prefix)/lib/node_modules/tldr/bin/completion/zsh/_tldr $ZSH_CUSTOM/plugins/tldr/_tldr
# yarn: ln -s $(yarn global dir)/node_modules/tldr/bin/completion/zsh/_tldr $ZSH_CUSTOM/plugins/tldr/_tldr
```

Then add tldr to your oh-my-zsh plugins,
Expand Down Expand Up @@ -154,7 +155,8 @@ fpath = (my/completions $fpath)
### Bash

```
ln -s bin/completion/bash/tldr ~/.tldr-completion.bash
ln -s $(npm config get prefix)/lib/node_modules/tldr/bin/completion/bash/tldr ~/.tldr-completion.bash
# yarn: ln -s $(yarn global dir)/node_modules/tldr/bin/completion/bash/tldr ~/.tldr-completion.bash
```

Now add the following line to our bashrc file:
Expand Down