Skip to content

Commit

Permalink
Add french translation of the README.md (#153)
Browse files Browse the repository at this point in the history
* Add french translation of the README.md

* Ignore all non-english documents
  • Loading branch information
Sigmanificient authored Dec 15, 2023
1 parent e334513 commit ddd7aa0
Show file tree
Hide file tree
Showing 4 changed files with 115 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<p align="center">
[English]
[<a href="doc/README-de.md">Deutsch</a>]
[<a href="doc/README-fr.md">Français</a>]
</p>

<img src="https://raw.githubusercontent.com/kyu08/fzf-make/main/static/demo.gif" />
Expand Down
2 changes: 1 addition & 1 deletion _typos.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
ratatui = "ratatui"

[files]
extend-exclude = ["doc/README-de.md"]
extend-exclude = ["doc/README-*.md"]
1 change: 1 addition & 0 deletions doc/README-de.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<p align="center">
[<a href="../README.md">English</a>]
[Deutsch]
[<a href="../doc/README-fr.md">Français</a>]
</p>

<img src="https://raw.githubusercontent.com/kyu08/fzf-make/main/static/demo.gif" />
Expand Down
112 changes: 112 additions & 0 deletions doc/README-fr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
<div align="center">

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

`fzf-make` est un outil en ligne de commmandes qui éxecute des cibles make en utilisant un Fuzzy Finder avec une fenêtre de prévisualisation

![License:MIT](https://img.shields.io/static/v1?label=License&message=MIT&color=blue&style=flat-square)
[![Latest Release](https://img.shields.io/github/v/release/kyu08/fzf-make?style=flat-square)](https://github.com/kyu08/fzf-make/releases/latest)
[![crates.io](https://img.shields.io/crates/v/fzf-make?style=flatflat-square)](https://crates.io/crates/fzf-make)

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

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

</div>

# 🛠️ Fonctionnalitées
- Selectionner et éxecuter une cible make avec fzf
- Supporte les instructions `include`
- **(dévelopement planifié)** Supporte un fichier de configuration
- **(dévelopement planifié)** Historique des commandes

# 👓 Pré-requis
- [bat](https://github.com/sharkdp/bat) (Dans le futuer, nous prévoyons de le
faire aussi marcher avec `cat`, mais pour l'instant, il ne marche qu'avec `bat`.)

# 📦 Installation
## macOS
### Homebrew
Vous n'avez pas besoin d'installer `bat` car `fzf-make` l'installera automatiquement avec Homebrew.

```sh
# installer
brew tap kyu08/tap
brew install kyu08/tap/fzf-make
```

```sh
# Mise à jour
brew upgrade fzf-make
```

## Arch Linux

`fzf-make` peut être installé depuis le [AUR](https://aur.archlinux.org/packages/fzf-make) en utilisant un [assistant AUR](https://wiki.archlinux.org/title/AUR_helpers_(Fran%C3%A7ais)). Par exemple:

```sh
paru -S fzf-make
```

## NixOS / Nix (gestionnaire de paquets)
`fzf-make` peut être lancé depuis le référentiel (dernière version)
```sh
nix run github:kyu08/fzf-make
```

Ou depuis les nixpkgs (channel >= 23.05)
```sh
nix run nixpkgs#fzf-make
```

> **Note**
> Vous devrez possblement activer les fonctionnalitées expérimentales. Dans ce cas, éxecutez la command ci-dessous pour les activer
> `echo "experimental-features = nix-command flakes" | tee ~/.config/nix/nix.conf`
## Méthode indépendante du système d'exploitation
### Cargo
```sh
cargo install fzf-make
```

# 💡 Usage
## Run `fzf-make`
1. Exectuez `fzf-make` dans le dossier qui possède un fichier make (le noms doit être l'un des suivant: `GNUmakefile`, `makefile`, `Makefile`)
2. Selectionnez la commande à éxecuter

## Commandes
| Commande | Sortie |
|--------|--------|
| `fzf-make` | <img width="752" alt="help.png" src="https://raw.githubusercontent.com/kyu08/fzf-make/main/static/demo.png">|
| `fzf-make --help` / `fzf-make -h` / `fzf-make help` | <img width="752" alt="help.png" src="https://raw.githubusercontent.com/kyu08/fzf-make/main/static/help.png">|
| `fzf-make --version` / `fzf-make -v` / `fzf-make version` | <img width="752" alt="version.png" src="https://raw.githubusercontent.com/kyu08/fzf-make/main/static/version.png"> |
| `fzf-make --old` / `fzf-make -o` / `fzf-make old` | <img width="752" alt="version.png" src="https://raw.githubusercontent.com/kyu08/fzf-make/main/static/old.png"> |
| `fzf-make ${some_invalid_command}` | <img width="752" alt="invalid-arg.png" src="https://raw.githubusercontent.com/kyu08/fzf-make/main/static/invalid-arg.png"> |

# 💻 Dévelopment
1. Clonez ce dépôt
2. Changez le code
3. Lancez `make run`

Pour éxecuter les tests, lancez `make test`(requiert `nextest`). Ou juste lancez `cargo test`.

## nix
Ou vous pouvez utiliser `nix` pour créer un interpreteur de commande avec les dépendances du projet.

À la racine le dépôt, éxecutez la commande ci-dessous:
```nix
nix develop
```

# 👥 Contribution
- Les contributions sont bienvenues!
- Si vous avez une demande de fonctionnalité, merci d'ouvrir une issue en premier.
- Si vous ajoutez fzf-make à un gestionnaire de paquets, merci de me le faire savoir. (ou envoyez une demande de tirage (pr) pour ajoutez les instructions d'installation avec le gestionnaire dans `README.md`)
- Si vous avez des questions, n'hésitez pas à les demander à travers une issue.

# 🗒 Article(s) liés
- (Japanese)[Makefileに定義されたtargetをfzfで選択して実行するCLIツールをRustでつくった](https://blog.kyu08.com/posts/fzf-make)

0 comments on commit ddd7aa0

Please sign in to comment.