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.

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

Conversation

neo-sam
Copy link

@neo-sam neo-sam commented Aug 13, 2022

fix completion path

Description

Change unclear relative path to real absolute path for user setup.

Checklist

  • Code compiles correctly
  • Created tests, if possible
  • All tests passing (npm run test:all)
  • Extended the README / documentation, if necessary

fix install path
@@ -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?

@kbdharun kbdharun changed the base branch from master to main October 3, 2023 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants