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

Add "Example aliases" to README #395

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add "Example aliases" to README #395

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a810d6f
add: `aliase examples`
mei28 Dec 13, 2024
6256ee4
fix: change the section's position.
mei28 Dec 13, 2024
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
27 changes: 21 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,6 @@
[![crates.io](https://img.shields.io/crates/v/fzf-make?style=flatflat-square)](https://crates.io/crates/fzf-make)
[![Crates.io Total Downloads](https://img.shields.io/crates/d/fzf-make)](https://crates.io/crates/fzf-make)

<p align="center">
[English]
[<a href="doc/README-de.md">Deutsch</a>]
[<a href="doc/README-fr.md">Français</a>]
</p>

Comment on lines -12 to -17
Copy link
Owner

Choose a reason for hiding this comment

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

I'm sorry for giving you a misunderstanding.
Please revert this deletion. 🙏

In description of #301, I wanted to show that READMEs other than English just need not to modified.

I'm going to delete them by another PR.

<img src="https://raw.githubusercontent.com/kyu08/fzf-make/main/static/demo.gif" />

</div>
Expand Down Expand Up @@ -109,6 +103,27 @@ Whether `package.json` and `yarn.lock` are in the current directory.
| `fzf-make --help` / `fzf-make help` | Show help |
| `fzf-make --version` / `fzf-make -v` / `fzf-make version` | Show version |

## Example Aliases
To simplify the usage of `fzf-make`, you can define aliases in your shell configuration. Below is an example configuration that works for most shells (bash, zsh, fish, etc.):

```sh
alias fm='fzf-make'
alias fr='fzf-make repeat'
alias fh='fzf-make history'
```
### Setting Up
1. Add the above lines to your shell's configuration file:
* For bash: `~/.bashrc`
* For zsh: `~/.zshrc`
* For fish: `~/.config/fish/config.fish` (use alias syntax as shown above)
1. Reload your shell configuration:
bash/zsh: `source ~/.bashrc` or `source ~/.zshrc`
fish: `source ~/.config/fish/config.fish`
### Example Usage
* `fm`: Launch fzf-make to select and run a target.
* `fr`: Repeat the last executed command.
* `fh`: Open fzf-make with the history pane focused.
Comment on lines +114 to +125
Copy link
Owner

Choose a reason for hiding this comment

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

I think it's enough that showing example settings only. 👍
So please delete L114-L125.

Suggested change
### Setting Up
1. Add the above lines to your shell's configuration file:
* For bash: `~/.bashrc`
* For zsh: `~/.zshrc`
* For fish: `~/.config/fish/config.fish` (use alias syntax as shown above)
1. Reload your shell configuration:
bash/zsh: `source ~/.bashrc` or `source ~/.zshrc`
fish: `source ~/.config/fish/config.fish`
### Example Usage
* `fm`: Launch fzf-make to select and run a target.
* `fr`: Repeat the last executed command.
* `fh`: Open fzf-make with the history pane focused.


# 💻 Development
1. Clone this repository
1. Change the codes
Expand Down
Loading