Skip to content

Commit 80b197a

Browse files
authored
Update README.md
1 parent 279fff4 commit 80b197a

1 file changed

Lines changed: 108 additions & 90 deletions

File tree

README.md

Lines changed: 108 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,100 @@
1-
2-
🌀 Sendgit
1+
# 🌀 Sendgit
32

43
Sendgit est un outil Bash interactif qui simplifie l’utilisation de Git. Il te guide pas à pas pour ajouter, committer et pousser tes fichiers vers n’importe quelle branche d’un dépôt GitHub.
54

6-
<h3>🚀 Fonctions disponibles</h3>
7-
8-
<strong>1. Envoyer des modifications sur GitHub</strong><br>
9-
- Ajout de fichiers<br>
10-
- Commit avec message personnalisé<br>
11-
- Push vers une branche au choix<br><br>
5+
### 🚀 Fonctions disponibles
126

13-
<strong>2. Récupérer les dernières modifications (pull)</strong><br><br>
7+
**1. Envoyer des modifications sur GitHub**
8+
- Ajout de fichiers
9+
- Commit avec message personnalisé
10+
- Push vers une branche au choix
1411

15-
<strong>3. Afficher l’historique complet des commits</strong> (<code>git log</code>)<br><br>
12+
**2. Récupérer les dernières modifications (pull)**
1613

17-
<strong>4. Afficher un résumé des commits</strong> (<code>git log --oneline</code>)<br><br>
14+
**3. Afficher l’historique complet des commits** (`git log`)
1815

19-
<strong>5. Restaurer un fichier supprimé/modifié</strong><br>
20-
- À partir de n’importe quel commit<br><br>
16+
**4. Afficher un résumé des commits** (`git log --oneline`)
2117

22-
<strong>6. Changer de branche Git facilement</strong><br><br>
18+
**5. Restaurer un fichier supprimé/modifié**
19+
- À partir de n’importe quel commit
2320

21+
**6. Changer de branche Git facilement**
2422

2523
---
2624

27-
📦 Installation
28-
29-
1. Cloner le dépôt :
30-
<code>git clone https://github.com/hasprogamer/Sendgit.git
31-
<br>cd Sendgit</code>
32-
33-
<h3>Sur ordinateur (Linux/macOS):</h3>
34-
35-
2. Rendre le script exécutable :
36-
<code>chmod +x github.sh</code>
37-
38-
3. Déplacer le script dans /usr/local/bin pour un accès global :
39-
<code>sudo mv github.sh /usr/local/bin/sendgit</code
40-
41-
Tu peux maintenant utiliser la commande directement :
42-
<code>sendgit</code>
25+
## 📦 Installation
26+
27+
### Sur ordinateur (Linux/macOS) :
28+
29+
1. Cloner le dépôt :
30+
```bash
31+
git clone https://github.com/hasprogamer/Sendgit.git
32+
cd Sendgit
33+
```
34+
2. Rendre le script exécutable :
35+
```bash
36+
chmod +x github.sh
37+
```
38+
3. Déplacer le script dans `/usr/local/bin` pour un accès global :
39+
```bash
40+
sudo mv github.sh /usr/local/bin/sendgit
41+
```
42+
4. Tu peux maintenant utiliser la commande directement :
43+
```bash
44+
sendgit
45+
```
4346

4447
---
4548

46-
<h3>Sur Android (Termux)</h3>
49+
### Sur Android (Termux)
4750

48-
1. Créer le dossier bin :
49-
<code>mkdir -p ~/bin</code>
51+
1. Créer le dossier `bin` :
52+
```bash
53+
mkdir -p ~/bin
54+
```
5055

51-
2. Déplacer le script dans ce dossier et le rendre exécutable : <br>
52-
<code>mv github.sh ~/bin/sendgit.sh<br></code>
53-
<code>chmod +x ~/bin/sendgit.sh</code>
56+
2. Déplacer le script dans ce dossier et le rendre exécutable :
57+
```bash
58+
mv github.sh ~/bin/sendgit.sh
59+
chmod +x ~/bin/sendgit.sh
60+
```
5461

55-
3.Ajouter ~/bin à ton PATH :
56-
<strong>Pour Bash</strong><br>
62+
3. Ajouter `~/bin` à ton PATH :
5763

58-
<code>echo 'export PATH=$HOME/bin:$PATH' >> ~/.bashrc<br></code><br>
64+
**Pour Bash**
65+
```bash
66+
echo 'export PATH=$HOME/bin:$PATH' >> ~/.bashrc
67+
echo 'alias sendgit="bash ~/bin/sendgit.sh"' >> ~/.bashrc
68+
source ~/.bashrc
69+
```
5970

60-
<code>echo 'alias sendgit="bash ~/bin/sendgit.sh"' >> ~/.bashrc<br></code><br>
71+
**Pour Zsh (par défaut sur Termux)**
72+
```bash
73+
echo 'export PATH=$HOME/bin:$PATH' >> ~/.zshrc
74+
echo 'alias sendgit="bash ~/bin/sendgit.sh"' >> ~/.zshrc
75+
source ~/.zshrc
76+
```
6177

62-
<code>source ~/.bashrc</code><br>
63-
64-
<strong>Pour Zsh(par défaut sur termux)</strong><br>
65-
66-
<code>echo 'export PATH=$HOME/bin:$PATH' >> ~/.zshrc<br></code><br>
67-
68-
<code>echo 'alias sendgit="bash ~/bin/sendgit.sh"' >> ~/.zshrc<code><br>
69-
70-
<code>source ~/.zshrc</code><br>
71-
72-
Ensuite, lance simplement la commande : <br>
73-
<code>sendgit</code>
78+
Ensuite, lance simplement la commande :
79+
```bash
80+
sendgit
81+
```
7482

7583
---
7684

77-
<h3>🔄 Mettre à jour Sendgit</h3>
85+
### 🔄 Mettre à jour Sendgit
7886

7987
Tu veux récupérer la dernière version ? C’est simple :
80-
cd Sendgit<br>
88+
```bash
89+
cd Sendgit
8190
bash install.sh
82-
91+
```
8392

8493
---
8594

86-
<h3>🚀 Exemple d’utilisation</h3>
95+
### 🚀 Exemple d’utilisation
8796

97+
```
8898
Fichiers modifiés :
8999
M index.html
90100
M script.sh
@@ -99,55 +109,63 @@ Sur quelle branche voulez-vous pousser ? (laisser vide pour 'main')
99109
> main
100110
101111
Opération en cours...
112+
```
102113
103114
---
104115
105-
🛠️ Contribution
116+
## 🛠️ Contribution
106117
107118
Tu souhaites améliorer ou personnaliser Sendgit ? Voici comment contribuer :
108119
109-
Pour les contributeurs externes (sans accès direct au dépôt) :
120+
### Pour les contributeurs externes (sans accès direct au dépôt) :
110121
111122
1. Forke le dépôt Sendgit sur GitHub (bouton "Fork").
112-
113-
2. Clone ton fork sur ta machine :
114-
git clone https://github.com/tonCompte/Sendgit.git
115-
116-
3. Va dans le dossier du projet :
117-
cd Sendgit
118-
119-
4. Crée une nouvelle branche pour ta modification :
120-
git checkout -b ma-nouvelle-fonctionnalite
121-
122-
5. Fais tes modifications et enregistre-les avec un commit :
123-
git commit -am "Description claire de ta modification"
124-
125-
6. Pousse ta branche sur ton fork :
126-
git push origin ma-nouvelle-fonctionnalite
127-
123+
2. Clone ton fork sur ta machine :
124+
```bash
125+
git clone https://github.com/tonCompte/Sendgit.git
126+
```
127+
3. Va dans le dossier du projet :
128+
```bash
129+
cd Sendgit
130+
```
131+
4. Crée une nouvelle branche pour ta modification :
132+
```bash
133+
git checkout -b ma-nouvelle-fonctionnalite
134+
```
135+
5. Fais tes modifications et enregistre-les avec un commit :
136+
```bash
137+
git commit -am "Description claire de ta modification"
138+
```
139+
6. Pousse ta branche sur ton fork :
140+
```bash
141+
git push origin ma-nouvelle-fonctionnalite
142+
```
128143
7. Sur GitHub, ouvre une Pull Request depuis ton fork vers le dépôt original.
129144
130145
---
131146
132-
Pour les contributeurs internes (avec accès en écriture) :
133-
134-
1. Clone le dépôt officiel :
135-
git clone https://github.com/hasprogamer/Sendgit.git
136-
137-
2. Va dans le dossier :
138-
cd Sendgit
139-
140-
3. Crée une branche pour tes modifications :
141-
git checkout -b ma-nouvelle-fonctionnalite
142-
143-
4. Modifie, commit, et pousse ta branche :
144-
git commit -am "Description claire de la modification"
145-
git push origin ma-nouvelle-fonctionnalite
146-
147+
### Pour les contributeurs internes (avec accès en écriture) :
148+
149+
1. Clone le dépôt officiel :
150+
```bash
151+
git clone https://github.com/hasprogamer/Sendgit.git
152+
```
153+
2. Va dans le dossier :
154+
```bash
155+
cd Sendgit
156+
```
157+
3. Crée une branche pour tes modifications :
158+
```bash
159+
git checkout -b ma-nouvelle-fonctionnalite
160+
```
161+
4. Modifie, commit, et pousse ta branche :
162+
```bash
163+
git commit -am "Description claire de la modification"
164+
git push origin ma-nouvelle-fonctionnalite
165+
```
147166
5. Ouvre une Pull Request sur GitHub.
148167
149168
---
150169
151170
Les mainteneurs du projet examineront ta Pull Request et pourront l’intégrer si tout est bon.
152171
---
153-

0 commit comments

Comments
 (0)