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

Add note in readme that content search examples are non-fuzzy #543

Closed
tobx opened this issue Sep 22, 2023 · 0 comments
Closed

Add note in readme that content search examples are non-fuzzy #543

tobx opened this issue Sep 22, 2023 · 0 comments

Comments

@tobx
Copy link

tobx commented Sep 22, 2023

Section As Interactive Interface states:

Normally you would want to integrate it with grep, ack, ag, or rg for searching contents in a project directory

The examples below show non-fuzzy file content searching. Switch to fuzzy mode (Control + Q) is possible, but I think not what you "normally" want. I think this leads to confusion. I took me a long time to understand what is going on here and that I am actually not using fuzzy search. See also #212.

I understand now that you can use skim only as an interface for other search tools and that is exactly what the headline says, but for me at least the examples led to confusion. Why would I "normally" use grep-like tools if I have skim?

I would recommend to add a note under those examples. Something like:

Note: Those examples show how to replace skim's search engine with other tools and use skim as an interface only. Fuzzy searching through file contents can for example be achieved with:

rg '' --color=always --line-number | sk --ansi

(probably there are better options than rg to simply pass file contents with line numbers to skim that I don't know of)

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

No branches or pull requests

1 participant