Skip to content

Commit 3c0cdea

Browse files
committed
Update README.md and LISEZMOI.md
1 parent 5485ae7 commit 3c0cdea

File tree

2 files changed

+51
-186
lines changed

2 files changed

+51
-186
lines changed

LISEZMOI.md

Lines changed: 27 additions & 170 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
# GoFileEncoder
22

3-
> 🇬🇧 Are you English ? Open [README.md](README.md) in English.
4-
3+
> 🇬🇧 Do you speak English ? Open [README.md](README.md) in English.
54
65
## Introduction
76

8-
GoFileEncoder est un petit encodeur de fichiers qui utilise l'[encryption XOR <sup>(EN)</sup>](https://en.wikipedia.org/wiki/XOR_cipher). Il est codé en Golang, et est compilé pour plusieurs OS (Windows&reg;, Linux&reg;,et bientôt macOS&reg;).
7+
GoFileEncoder est un petit encodeur de fichiers qui utilise l'[encryption XOR <sup>(EN)</sup>](https://en.wikipedia.org/wiki/XOR_cipher) (une autre ). Il est codé en Golang, et est compilé pour plusieurs OS (Windows&reg;, Linux&reg;,et bientôt macOS&reg;).
98

10-
Je ne suis pas un pro en Go, donc si vous trouvez un bug, ou simplement voulez faire une suggestion, je suis totalement ouvert aux [_issues_](https://github.com/eliotttak/GoFileEncoder/issues), [_pull requests_](https://github.com/eliotttak/GoFileEncoder/pulls) et à la [discussion](https://github.com/eliotttak/GoFileEncoder/discussions).
9+
Je ne suis pas un pro en Go, donc si vous trouvez un bug, ou simplement voulez faire une suggestion, je suis totalement ouvert aux [_issues_ <sup>(EN)</sup>](https://github.com/eliotttak/GoFileEncoder/issues), [_pull requests_ <sup>(EN)</sup>](https://github.com/eliotttak/GoFileEncoder/pulls) et à la [discussion <sup>(EN)</sup>](https://github.com/eliotttak/GoFileEncoder/discussions).
1110

1211
---
1312

@@ -17,10 +16,10 @@ Je ne suis pas un pro en Go, donc si vous trouvez un bug, ou simplement voulez f
1716
- [Sommaire](#sommaire)
1817
- [Construction](#construction)
1918
- [Clonage](#clonage)
20-
- [Arbre des dépendances](#arbre-des-dépendances)
19+
- [Arbre des dépendances du _package_](#arbre-des-dépendances-du-package)
20+
- [Dépendances de construction](#dépendances-de-construction)
2121
- [Installation des dépendances](#installation-des-dépendances)
22-
- [Création du _package_ d'_assets_](#création-du-package-dassets)
23-
- [Compilation](#compilation)
22+
- [Compilation et création du _package_ d'assets](#compilation-et-création-du-package-dassets)
2423
- [En Bash](#en-bash)
2524
- [En Batch](#en-batch)
2625
- [Utilisation](#utilisation)
@@ -31,23 +30,6 @@ Je ne suis pas un pro en Go, donc si vous trouvez un bug, ou simplement voulez f
3130
- [5. Attendez...](#5-attendez)
3231
- [6. Terminé !](#6-terminé-)
3332
- [License](#license)
34-
- [Introduction](#introduction-1)
35-
- [Sommaire](#sommaire-1)
36-
- [Construction](#construction-1)
37-
- [Clonage](#clonage-1)
38-
- [Arbre des dépendances](#arbre-des-dépendances-1)
39-
- [Installation des dépendances](#installation-des-dépendances-1)
40-
- [Compilation](#compilation-1)
41-
- [En Bash](#en-bash-1)
42-
- [En Batch](#en-batch-1)
43-
- [Utilisation](#utilisation-1)
44-
- [1. Encoder ou décoder ?](#1-encoder-ou-décoder--1)
45-
- [2. Sélectionnez un fichier](#2-sélectionnez-un-fichier-1)
46-
- [3. Entrez le mot de passe](#3-entrez-le-mot-de-passe-1)
47-
- [4. Choisissez le fichier de destination](#4-choisissez-le-fichier-de-destination-1)
48-
- [5. Attendez...](#5-attendez-1)
49-
- [6. Terminé !](#6-terminé--1)
50-
- [License](#license-1)
5133

5234

5335
## Construction
@@ -59,7 +41,7 @@ git clone https://github.com/eliotttak/GoFileEncoder
5941
cd GoFileEncoder
6042
```
6143

62-
### Arbre des dépendances
44+
### Arbre des dépendances du _package_
6345

6446
```plaintext
6547
GoFileEncoder (ce projet)
@@ -68,35 +50,38 @@ GoFileEncoder (ce projet)
6850
| |
6951
| \_ github.com/TheTitanrain/w32 (indirect)
7052
|
71-
\_ golang.org/x/term (pour la demande de mot de passe)
72-
|
73-
\_ golang.org/x/sys (indirect)
53+
+-- golang.org/x/term (pour la demande de mot de passe)
54+
| |
55+
| \_ golang.org/x/sys (indirect)
56+
|
57+
\_ github.com/christianhujer/isheadless (pour vérifier s'il y a une GUI)
7458
```
7559

7660
Se réferer au fichier [go.mod](./go.mod) pour plus de détails.
77-
> &#x1F6C8; Dans [go.mod](./go.mod), il peut y avoir une directive d'import pour [github.com/abdfnx/gosh](https://github.com/abdfnx/gosh). Il a été utilisé seulement pour mon installateur, et vous ne devriez pas en avoir besoin. Il devrait disparaître si vous exécutez `go mod tidy`.
61+
> &#x1F6C8; Dans [go.mod](./go.mod), il peut y avoir une directive d'import pour [github.com/abdfnx/gosh](https://github.com/abdfnx/gosh). Elle a été utilisée uniquement pour mon assistant d'installation, et vous ne devriez pas en avoir besoin. Elle va disparaître si vous exécutez `go mod tidy`.
62+
63+
### Dépendances de construction
64+
65+
- `github.com/go-bindata/go-bindata/go-bindata/...` (pour créer le fichier d'_assets_)
7866

7967
### Installation des dépendances
8068
```bash
8169
go mod tidy
70+
go install github.com/go-bindata/go-bindata/go-bindata/...
8271
go get
8372
```
84-
85-
### Création du _package_ d'_assets_
86-
```bash
87-
go-bindata -pkg assets -o assets/bindata.go LICENSE
88-
```
89-
90-
### Compilation
73+
### Compilation et création du _package_ d'assets
9174

9275
#### En Bash
9376
```bash
94-
go build -o ./bin/GoFileEncoder ./src/
77+
# Vous allez peut-être devoir exécuter 'chmod 744 build.sh'
78+
./build.sh # Vous pouvez ajouter une valeur de GOOS et une de GOARCH, par ex. './build.sh linux amd64'
9579
```
9680

9781
#### En Batch
9882
```batch
99-
go build -o .\bin\GoFileEncoder .\src\
83+
rem Vous pouvez ajouter une valeur de GOOS et une de GOARCH, par ex. 'build.bat windows amd64'
84+
build.bat
10085
```
10186

10287
---
@@ -106,7 +91,6 @@ go build -o .\bin\GoFileEncoder .\src\
10691
### 1. Encoder ou décoder ?
10792

10893
En premier, lancez le programme. Celui-ci va vous demander si vous souhaitez encoder ou décoder un fichier :
109-
11094
```plaintext
11195
Que voulez-vous faire ?
11296
- Encoder un fichier (e)
@@ -120,6 +104,8 @@ Si vous voulez encoder un fichier, entrez <kbd>e</kbd>, sinon, entrez <kbd>d</kb
120104
Ensuite, il va vous demander d'appuyez sur <kbd>Entrée</kbd> pour sélectionner un fichier. Faites-le, et un popup va apparaître. Sélectionnez votre fichier, puis validez.
121105
> &#x1F6C8; Si vous annulez, le popup va réapparaître 2 fois, puis à la 3<sup>ème</sup>, le message `"Trop de tentatives échouées"` va s'afficher puis le programme va se fermer.
122106
107+
> &#x1F6C8; Si votre configuration ne comprends pas d'interface graphique, vous allez devoir entrer manuellement le chemin absolu vers vorte fichier.
108+
123109
### 3. Entrez le mot de passe
124110

125111
Après cela, un mot de passe vous sera demandé. Entrez-le puis validez avec <kbd>Entrée</kbd>.
@@ -132,137 +118,8 @@ Après cela, un mot de passe vous sera demandé. Entrez-le puis validez avec <kb
132118
Ensuite, le programme va vous demander d'appuyez sur <kbd>Entrée</kbd> pour choisir le fichier de destination. Faites-le, et un popup va apparaître. Sélectionnez le fichier à créer, puis validez.
133119
> &#x1F6C8; Si vous annulez, le popup va réapparaître 2 fois, puis à la 3<sup>ème</sup>, le message `"Trop de tentatives échouées"` va s'afficher puis le programme va se fermer.
134120
135-
### 5. Attendez...
136-
137-
Le fichier est en train d'être encodé. Ne fermez pas le programme.
138-
139-
### 6. Terminé !
140-
Au bout de quelques secondes, le fichier est encodé ou décodé. Le programme se ferme automatiquement.
141-
142-
## License
143-
Ce logiciel est distribué sous la license GNU GENERAL PUBLIC LICENSE version 3 (GNU GPL v3).
144-
[Voir la license](..\# <small>(FR)</small> GoFileEncoder
145-
146-
## Introduction
147-
148-
GoFileEncoder est un petit encodeur de fichiers qui utilise l'[encryption XOR <sup>(EN)</sup>](https://en.wikipedia.org/wiki/XOR_cipher) (une autre ). Il est codé en Golang, et est compilé pour plusieurs OS (Windows&reg;, Linux&reg;,et bientôt macOS&reg;).
149-
150-
Je ne suis pas un pro en Go, donc si vous trouvez un bug, ou simplement voulez faire une suggestion, je suis totalement ouvert aux [_issues_ <sup>(EN)</sup>](https://github.com/eliotttak/GoFileEncoder/issues), [_pull requests_ <sup>(EN)</sup>](https://github.com/eliotttak/GoFileEncoder/pulls) et à la [discussion <sup>(EN)</sup>](https://github.com/eliotttak/GoFileEncoder/discussions).
151-
152-
---
153-
154-
## Sommaire
155-
- [GoFileEncoder](#gofileencoder)
156-
- [Introduction](#introduction)
157-
- [Sommaire](#sommaire)
158-
- [Construction](#construction)
159-
- [Clonage](#clonage)
160-
- [Arbre des dépendances](#arbre-des-dépendances)
161-
- [Installation des dépendances](#installation-des-dépendances)
162-
- [Création du _package_ d'_assets_](#création-du-package-dassets)
163-
- [Compilation](#compilation)
164-
- [En Bash](#en-bash)
165-
- [En Batch](#en-batch)
166-
- [Utilisation](#utilisation)
167-
- [1. Encoder ou décoder ?](#1-encoder-ou-décoder-)
168-
- [2. Sélectionnez un fichier](#2-sélectionnez-un-fichier)
169-
- [3. Entrez le mot de passe](#3-entrez-le-mot-de-passe)
170-
- [4. Choisissez le fichier de destination](#4-choisissez-le-fichier-de-destination)
171-
- [5. Attendez...](#5-attendez)
172-
- [6. Terminé !](#6-terminé-)
173-
- [License](#license)
174-
- [Introduction](#introduction-1)
175-
- [Sommaire](#sommaire-1)
176-
- [Construction](#construction-1)
177-
- [Clonage](#clonage-1)
178-
- [Arbre des dépendances](#arbre-des-dépendances-1)
179-
- [Installation des dépendances](#installation-des-dépendances-1)
180-
- [Compilation](#compilation-1)
181-
- [En Bash](#en-bash-1)
182-
- [En Batch](#en-batch-1)
183-
- [Utilisation](#utilisation-1)
184-
- [1. Encoder ou décoder ?](#1-encoder-ou-décoder--1)
185-
- [2. Sélectionnez un fichier](#2-sélectionnez-un-fichier-1)
186-
- [3. Entrez le mot de passe](#3-entrez-le-mot-de-passe-1)
187-
- [4. Choisissez le fichier de destination](#4-choisissez-le-fichier-de-destination-1)
188-
- [5. Attendez...](#5-attendez-1)
189-
- [6. Terminé !](#6-terminé--1)
190-
- [License](#license-1)
191-
192-
193-
## Construction
194-
195-
### Clonage
196-
197-
```bash
198-
git clone https://github.com/eliotttak/GoFileEncoder
199-
cd GoFileEncoder
200-
```
121+
> &#x1F6C8; Si votre configuration ne comprends pas d'interface graphique, vous allez devoir entrer manuellement le chemin absolu vers vorte fichier.
201122
202-
### Arbre des dépendances
203-
204-
```plaintext
205-
GoFileEncoder (ce projet)
206-
|
207-
+-- github.com/sqweek/dialog (pour les popups des fichiers)
208-
| |
209-
| \_ github.com/TheTitanrain/w32 (indirect)
210-
|
211-
\_ golang.org/x/term (pour la demande de mot de passe)
212-
|
213-
\_ golang.org/x/sys (indirect)
214-
```
215-
216-
Se réferer au fichier [go.mod](./go.mod) pour plus de détails.
217-
218-
### Installation des dépendances
219-
```bash
220-
go mod tidy
221-
```
222-
223-
### Compilation
224-
225-
#### En Bash
226-
```bash
227-
go build -o ./bin/GoFileEncoder ./src/
228-
```
229-
230-
#### En Batch
231-
```batch
232-
go build -o .\bin\GoFileEncoder .\src\
233-
```
234-
235-
---
236-
237-
## Utilisation
238-
239-
### 1. Encoder ou décoder ?
240-
241-
En premier, lancez le programme. Celui-ci va vous demander si vous souhaitez encoder ou décoder un fichier :
242-
```plaintext
243-
Que voulez-vous faire ?
244-
- Encoder un fichier (e)
245-
- Décoder un fichier (d)
246-
(e/d)>>>
247-
```
248-
Si vous voulez encoder un fichier, entrez <kbd>e</kbd>, sinon, entrez <kbd>d</kbd>. Dans tous les cas, validez avec <kbd>Entrée</kbd>.
249-
250-
### 2. Sélectionnez un fichier
251-
252-
Ensuite, il va vous demander d'appuyez sur <kbd>Entrée</kbd> pour sélectionner un fichier. Faites-le, et un popup va apparaître. Sélectionnez votre fichier, puis validez.
253-
> &#x1F6C8; Si vous annulez, le popup va réapparaître 2 fois, puis à la 3<sup>ème</sup>, le message `"Trop de tentatives échouées"` va s'afficher puis le programme va se fermer.
254-
255-
### 3. Entrez le mot de passe
256-
257-
Après cela, un mot de passe vous sera demandé. Entrez-le puis validez avec <kbd>Entrée</kbd>.
258-
> &#x26A0; Si vous avez choisi `Décoder un fichier`, faîtes attention à bien écrire le mot de passe. Si vous vous trompez ne serait-ce que d'un caractère, le fichier sera corrompu et ne sera plus utilisable.
259-
260-
> &#x1F6C8; Pour garantir la confidentialité de votre mot de passe, celui-ci ne s'affichera pas sur votre écran.
261-
262-
### 4. Choisissez le fichier de destination
263-
264-
Ensuite, le programme va vous demander d'appuyez sur <kbd>Entrée</kbd> pour choisir le fichier de destination. Faites-le, et un popup va apparaître. Sélectionnez le fichier à créer, puis validez.
265-
> &#x1F6C8; Si vous annulez, le popup va réapparaître 2 fois, puis à la 3<sup>ème</sup>, le message `"Trop de tentatives échouées"` va s'afficher puis le programme va se fermer.
266123

267124
### 5. Attendez...
268125

@@ -274,4 +131,4 @@ Au bout de quelques secondes, le fichier est encodé ou décodé. Le programme s
274131
## License
275132
Ce logiciel est distribué sous la license GNU GENERAL PUBLIC LICENSE version 3 (GNU GPL v3).
276133

277-
[Voir la license <sup>(EN)</sup>](LICENSE))
134+
[Voir la license <sup>(EN)</sup>](LICENSE)

README.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GoFileEncoder
22

3-
> &#x1F1EB;&#x1F1F7; Vous êtes français ? Ouvrez [LISEZMOI.md](LISEZMOI.md) en français
3+
> &#x1F1EB;&#x1F1F7; Vous parlez français ? Ouvrez [LISEZMOI.md](LISEZMOI.md) en français
44
55
## Introduction
66

@@ -16,10 +16,10 @@ I am not a pro in Go, so if you find a bug, or simply want to make a suggestion,
1616
- [Summary](#summary)
1717
- [Building](#building)
1818
- [Cloning](#cloning)
19-
- [Dependencies tree](#dependencies-tree)
19+
- [Package dependencies tree](#package-dependencies-tree)
20+
- [Building dependencies](#building-dependencies)
2021
- [Dependencies installing](#dependencies-installing)
21-
- [Creating assets package](#creating-assets-package)
22-
- [Compiling](#compiling)
22+
- [Compiling and creating assets package](#compiling-and-creating-assets-package)
2323
- [In Bash](#in-bash)
2424
- [In Batch](#in-batch)
2525
- [Usage](#usage)
@@ -41,7 +41,7 @@ git clone https://github.com/eliotttak/GoFileEncoder
4141
cd GoFileEncoder
4242
```
4343

44-
### Dependencies tree
44+
### Package dependencies tree
4545

4646
```plaintext
4747
github.com/eliotttak/GoFileEncoder (this project)
@@ -50,35 +50,38 @@ github.com/eliotttak/GoFileEncoder (this project)
5050
| |
5151
| \_ github.com/TheTitanrain/w32 (indirect)
5252
|
53-
\_ golang.org/x/term (for the password asking)
54-
|
55-
\_ golang.org/x/sys (indirect)
53+
+-- golang.org/x/term (for the password asking)
54+
| |
55+
| \_ golang.org/x/sys (indirect)
56+
|
57+
\_ github.com/christianhujer/isheadless (to verify if there is a GUI)
5658
```
5759

5860
Refer to the file [go.mod](./go.mod) for more details.
5961
> &#x1F6C8; In [go.mod](./go.mod), there can be an import for [github.com/abdfnx/gosh](https://github.com/abdfnx/gosh). It was used only for my setup, and you shouldn't need it. It will disappear if you run `go mod tidy`.
6062
63+
### Building dependencies
64+
- `github.com/go-bindata/go-bindata/go-bindata/...` (to create the assets file)
65+
6166
### Dependencies installing
6267
```bash
6368
go mod tidy
69+
go install github.com/go-bindata/go-bindata/go-bindata/...
6470
go get
6571
```
6672

67-
### Creating assets package
68-
```bash
69-
go-bindata -pkg assets -o assets/bindata.go LICENSE
70-
```
71-
72-
### Compiling
73+
### Compiling and creating assets package
7374

7475
#### In Bash
7576
```bash
76-
go build -o ./bin/GoFileEncoder ./src/
77+
# You will maybe have to run 'chmod 744 build.sh'
78+
./build.sh # You can add GOOS and GOARCH values, e.g. './build.sh linux amd64'
7779
```
7880

7981
#### In Batch
8082
```batch
81-
go build -o .\bin\GoFileEncoder .\src\
83+
rem You can add GOOS and GOARCH values, e.g. 'build.bat windows amd64'
84+
build.bat
8285
```
8386

8487
---
@@ -102,6 +105,9 @@ If you want to encode a file, enter <kbd>e</kbd>, else, enter <kbd>d</kbd>. In a
102105
Then, it will ask you to press <kbd>Enter</kbd> to select a file. Do it, and a popup will aappear. Select your file, then confirm.
103106
> &#x1F6C8; If you cancel, the popup will appear back twice, then at the 3<sup>rd</sup>, the message `"Trop de tentatives échouées"` (`Too many failed attempts`) will be displayed and the program will be closed.
104107
108+
> &#x1F6C8; If your configuration don't include graphic interface, you will have to enter manually the absolute path to your file.
109+
110+
105111
### 3. Enter the password
106112

107113
After it, you will be asked for a password. Enter it then confirm by pressing <kbd>Enter</kbd>.
@@ -114,6 +120,8 @@ After it, you will be asked for a password. Enter it then confirm by pressing <k
114120
Then, the program will ask you to press <kbd>Entrée</kbd> to choose the destination file. Do it, and a popup will aappear. Select the file to create, then confirm.
115121
> &#x1F6C8; If you cancel, the popup will appear back twice, then at the 3<sup>rd</sup>, the message `"Trop de tentatives échouées"` (`Too many failed attempts`) will be displayed and the program will be closed.
116122
123+
> &#x1F6C8; If your configuration don't include graphic interface, you will have to enter manually the absolute path to your file.
124+
117125
### 5. Wait...
118126

119127
The file is being encoded. Do not close the program.

0 commit comments

Comments
 (0)