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

Better demo screencast #3

Open
sio opened this issue Jul 19, 2018 · 0 comments
Open

Better demo screencast #3

sio opened this issue Jul 19, 2018 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@sio
Copy link
Owner

sio commented Jul 19, 2018

The screencast in the README was done in a hurry after next to no planning and probably fails to convey some of the important features of bash-complete-partial-path.

This issue is a place to discuss, plan and submit a better screencast.

Current screencast outline

https://asciinema.org/a/0zhzOYbkF22pWLmbx1RHCYyqQ

  • Path completion:
    • for files
    • for directories (with cd)
  • Tilde expansion:
    • Simple (~)
    • Advanced (~1 with pushd)
  • Escaping special characters in file path
    • A directory name with spaces
  • Completion of special characters with opened quotes:
    • '
    • "

Possible enhancements

  • Resolving ambiguity in the middle of path

    All the samples in current screencast differ only in the last element of the path. Perhaps a better example would be the one with ambiguity in the middle, like /u/s/c -> /usr/share/cygwin, /usr/ssl/cert.pem, /usr/ssl/certs

  • Side-by-side comparison with traditional completion

    It would be good to have an example that shows how many keystrokes can be saved with the enhanced path completion, e.g. with something like /usr/share/perl5/core_perl: it would take a lot of interim tabbing with default completion and only one tab after /u/s/p/core with this project.

How you can help

  1. Suggest other illustrative examples that might attract users previously unfamiliar with such completion
  2. Suggest a whole new outline for a better screencast
  3. Comment on existing outline and suggestions
  4. Record a better screencast with or without discussing the outline first (some tips to get started, I also recommend -w 0.5 or -w 0.4).

The plan is to gather some feedback and to record a replacement screencast for the README. I can do the recording myself if no one else volunteers, I just need a better outline.

@sio sio added help wanted Extra attention is needed good first issue Good for newcomers labels Jul 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant