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

Thoroughly document features and improve configuration section #48

Merged
merged 20 commits into from
Oct 19, 2020

Conversation

PatrickF1
Copy link
Owner

@PatrickF1 PatrickF1 commented Oct 19, 2020

Improve feature explanations by creating a new section and describe the features in a methodical and thorough way, each with their own sub-section.

Additionally, improve explanations of configuration and troubleshooting.

@PatrickF1 PatrickF1 force-pushed the redo-features-explanations branch from 49a251f to 1fdde5d Compare October 19, 2020 16:29
@PatrickF1 PatrickF1 force-pushed the redo-features-explanations branch from c49abc3 to 2da081f Compare October 19, 2020 17:19
@PatrickF1 PatrickF1 force-pushed the redo-features-explanations branch from 12d6858 to 85aecbc Compare October 19, 2020 18:07
@PatrickF1 PatrickF1 force-pushed the redo-features-explanations branch from 633edf9 to 558d7a2 Compare October 19, 2020 18:38
@@ -156,7 +183,7 @@ Fzf optionally comes with its own [fish extension][]. It is substantial but `fzf
[fisher]: https://github.com/jorgebucaran/fisher
[fzf_default_opts]: https://github.com/junegunn/fzf#environment-variables
[fzf]: https://github.com/junegunn/fzf
[git log]: images/git_log.gif
[git log search]: images/git_log.gif
Copy link
Owner Author

Choose a reason for hiding this comment

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

Realized all the other gif link names had an action verb at the end so make the git log link name follow suit.

@@ -67,13 +92,15 @@ If you are on certain distribution of Linux, you will need to alias `fdfind` to

### Using custom key bindings

Each function is assigned mnemonic key bindings by default (see screenshots above) in [conf.d/fzf.fish][]. However, if you would like to customize them, you can prevent the default key bindings from executing by setting `fzf_fish_custom_keybindings` as a [universal variable][]. You can do this by running
If you would like to customize the key bindings, first, prevent the default key bindings from executing by setting `fzf_fish_custom_keybindings` as an [universal variable][]. You can do this with
Copy link
Owner Author

Choose a reason for hiding this comment

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

Now that the key bindings and their mnemonics are more prominent, don't need to reference them; assume the reader is already aware of them.

@PatrickF1 PatrickF1 changed the title Redo feature explanations section in readme Thoroughly document features and improve configuration section Oct 19, 2020
@PatrickF1 PatrickF1 merged commit 872136c into main Oct 19, 2020
@PatrickF1 PatrickF1 deleted the redo-features-explanations branch October 19, 2020 20:34
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.

1 participant