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 "Example aliases" to README #395

Merged
merged 3 commits into from
Dec 14, 2024
Merged

Add "Example aliases" to README #395

merged 3 commits into from
Dec 14, 2024

Conversation

mei28
Copy link
Contributor

@mei28 mei28 commented Dec 13, 2024

Resolves #301

  • Added a section for Example aliases in the README.
  • Removed paths to non-English versions of README.md and retained only the English version.

@mei28 mei28 marked this pull request as draft December 13, 2024 08:18
@mei28 mei28 marked this pull request as ready for review December 13, 2024 08:20
Copy link
Owner

@kyu08 kyu08 left a comment

Choose a reason for hiding this comment

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

Thank you for submitting and taking your time for this! 💪
Please check my comments. Please ask me if you have any question.

README.md Outdated
Comment on lines 114 to 125
### 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.
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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

README.md Outdated
Comment on lines 12 to 17
<p align="center">
[English]
[<a href="doc/README-de.md">Deutsch</a>]
[<a href="doc/README-fr.md">Français</a>]
</p>

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

@mei28
Copy link
Contributor Author

mei28 commented Dec 13, 2024

@kyu08
I've fixed. please check it!

Copy link
Owner

@kyu08 kyu08 left a comment

Choose a reason for hiding this comment

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

Great work!

Thank you for the contribution!

@kyu08 kyu08 merged commit 30fe105 into kyu08:main Dec 14, 2024
1 check passed
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.

Add "Example aliases" to README
2 participants