Premiers pas avec github

Markdown aromatisé GitHub

GitHub étend la syntaxe [Markdown][1] pour fournir de nouvelles fonctionnalités utiles.

Entête 

# Header1
## Header2
### Header3
#### Header4
##### Header5
###### Header6
H1
===
H2
---

[![en-tête][2]][2]

Accent 

*Italic1* _Italic2_
**Bold1** __Bold2__
***Bold_Italic***
~~Strikethrough~~

[![Souligné][3]][3]

Ligne horizontale 

---
***
___

[![ligne horizontale][4]][4]

Liste 

unordered list:

* item-1
  * sub-item-1
  * sub-item-2
- item-2
  - sub-item-3
  - sub-item-4
+ item-3
  + sub-item-5
  + sub-item-6


ordered list:

1. item-1
  1. sub-item-1
  2. sub-item-2
2. item-2
  1. sub-item-3
  2. sub-item-4
3. item-3

[![list][5]][5]

Table 

Table Header-1 | Table Header-2 | Table Header-3
:--- | :---: | ---:
Table Data-1 | Table Data-2 | Table Data-3
TD-4 | Td-5 | TD-6
Table Data-7 | Table Data-8 | Table Data-9

[![table][6]][6]

code 

inline code- `int i=0`

block code-
``` C
for(int i=0; i<10; i++){
    printf("Hallow World! \n");
}
```

[![code][7]][7]

Devis 

> Stay hungry; stay foolish.
>> Quality is better than quantity.
>>> Life is not fair; get used to it.

[![citation][8]][8]

Lien 

https://github.com    
[GitHub](https://github.com)    
[GitHub](https://github.com "github website")    
[GitHub][1]    

[1]: https://github.com

[![Lien][9]][9]

Image 

![GitHub Logo](https://assets-cdn.github.com/images/icons/emoji/octocat.png "GitHub")

[![image][10]][10]

Listes de tâches 

- [x] completed item
- [ ] incomplete item

[![liste des tâches][11]][11]

Émoji 

:octocat: 👍 📖 👻 💡 👿

Pour tous les emojis GitHub, visitez- [Emoji Cheat Sheet] [12].

références SHA

Toute référence à un hachage SHA1 d’un commit sera convertie en un lien vers le commit lui-même sur GitHub :

e7909ea4fbb162db3f7f543d43c30684a3fb745f

[![sha1][13]][13]

Pull Request et Issue Références

Toute référence à une demande d’extraction ou à un problème sera automatiquement liée à cette demande d’extraction ou à ce problème.

Cela peut être fait en mettant un # devant le numéro du problème/Pull Request.

[1] : https://www.wikiod.com/fr/markdown/formatage-du-texte [2] : http://i.stack.imgur.com/cqpyj.png [3] : http://i.stack.imgur.com/BPzpc.png [4] : http://i.stack.imgur.com/fbLlM.png [5] : http://i.stack.imgur.com/LbesJ.png [6] : http://i.stack.imgur.com/AQIlG.png [7] : http://i.stack.imgur.com/kWuYH.png [8] : http://i.stack.imgur.com/WVRKq.png [9] : http://i.stack.imgur.com/Z18Ro.png [10] : http://i.stack.imgur.com/rDfU0.png [11] : http://i.stack.imgur.com/ve7lw.png [12] : http://www.emoji-cheat-sheet.com/ [13] : http://i.stack.imgur.com/pNfI8.png

Installation ou configuration

GitHub est une énorme collection de référentiels Git. En d’autres termes, vous pouvez considérer GitHub comme une collection de nombreux projets !

Créer un compte

  • Visitez la page principale de GitHub ici
  • Choisissez un nom d’utilisateur, entrez votre adresse e-mail et choisissez un mot de passe sécurisé et vous êtes prêt à partir !

Outils utiles

Pour les débutants Git/GitHub, comprendre le fonctionnement du contrôle de version peut être déroutant au début. Il existe une version graphique de GitHub que vous pouvez télécharger et utiliser. GitHub Desktop n’est que cet outil.

Création de votre premier référentiel

Vous pouvez considérer un référentiel comme un projet. Vous pouvez créer un référentiel en ligne ou hors ligne. Suivez les étapes ci-dessous :

En ligne

  1. Connectez-vous d’abord et accédez à votre profil.
  2. Accédez à l’onglet “Référentiels” en haut de la page
  3. Appuyez sur le bouton vert “Nouveau” et vous êtes prêt à gronder !

Hors ligne

  1. Téléchargez et installez [git][1] (choisissez le système d’exploitation que vous utilisez)
  2. Après le téléchargement et l’installation, vous pouvez soit utiliser l’outil de ligne de commande, soit télécharger un client graphique.
  3. Après l’installation, créez un compte sur [github][2]
  4. En haut à droite, cliquez sur le + et choisissez soit de créer un nouveau référentiel, soit d’en importer un existant.
  5. Si vous en choisissez un nouveau, entrez le nom du référentiel et choisissez de le rendre public ou privé.
  6. Cliquez sur : Créer un référentiel

N.B. Les référentiels privés ne sont pas disponibles pour les utilisateurs gratuits.

[1] : https://git-scm.com/downloads [2] : https://github.com/

Fichier LISEZMOI

Si votre projet n’a pas README.md, GitHub peut analyser README.rdoc pour afficher les détails. S’il a les deux, il utilisera README.md, ignorant silencieusement rdoc.

Un fichier README peut inclure-


Titre du projet

Décrivez brièvement votre projet. Vous pouvez également fournir le lien du site Web du projet, les badges, la communauté et les coordonnées (c. e-mail, site social).

Télécharger

Lien de fichier exécutable (fichier exécutable ou minifié ou d’installation). Il peut également y avoir des liens vers des versions précédentes.

Installation

Comment votre travail peut être utilisé. Il peut inclure les prérequis, les paramètres, les bibliothèques tierces, l’utilisation, les précautions, etc.

Manifestation

Il peut inclure un exemple de code, un fichier gif, un lien vidéo ou même des captures d’écran.

Auteurs

Noms des auteurs, coordonnées, etc.

Remerciements

Liste des personnes ou de la communauté aidées et inspirées tout au long du projet

Contribuant

Instructions pour contribuer (c’est-à-dire ajouter une fonctionnalité, signaler un bogue, soumettre un correctif) au projet. Peut également inclure un lien vers la documentation.

Licence

Donnez une courte introduction sur votre licence. Vous pouvez également donner un lien vers le site de la licence.

Fichier de LICENCE

GitHub vous aide à ajouter rapidement une licence à votre référentiel, comme alternative à l’ajout de votre propre fichier texte/markdown.

  1. Dans votre référentiel, cliquez sur “Créer un nouveau fichier”

[![étape 1][1]][1]

  1. À la page suivante :

    1. Type LICENSE.md or LICENSE.txt as the new file’s file name.
    2. The Want to use a new template? dialog will appear.

    [![step 2][2]][2]

  2. Choisissez votre licence préférée.

    [![step 3][3]][3]

  3. La licence que vous pouvez voir dans les détails du référentiel :

    [![step 4][4]][4]

De [Q&A - Comment ajouter une licence à un projet Github existant][5]

[1] : http://i.stack.imgur.com/fULI2.png [2] : http://i.stack.imgur.com/5pTQt.png [3] : http://i.stack.imgur.com/sKiKg.png [4] : https://i.stack.imgur.com/ZB89m.png [5] : http://stackoverflow.com/a/37895659/3193542

Suppression de données sensibles ou de fichiers volumineux →