Update readme for clone SSH project

This commit is contained in:
Maxime Maurin 2023-08-12 18:04:42 +02:00
parent 08d2aecea2
commit 265d3209c5
7 changed files with 64 additions and 11 deletions

View File

@ -42,22 +42,55 @@ Si vous avez déjà installé Visual Studio sur votre ordinateur mais que ces mo
Pour récupérer le projet, je supposerai ici que vous utilisez **GitHub Desktop**.
1. Cliquez sur `File > Clone Repository` (ou appuyez sur Ctrl+Shift+O).
### Création d'une clé SSH
2. Cliquez sur l'onglet **URL** et rentrez le l'URL du dépôt du projet https://git.zblorg.xyz/rob/Pawn ainsi que le chemin où vous souhaiter installer les fichiers du projet.
Parce que Wwise est trop lourd, la récupération d'un projet en HTTPS ne fonctionne pas. Il faut télécharger le projet avec un lien SSH. Pour ce faire, il vous faut générer une clé SSH comme suit :
1. Ouvrez un terminal de commande (cherchez **Terminal** dans la barre de recherche Windows).
![terminal](Resources/Readme/terminal.png)
2. Tapez la commande `ssh-keygen` et appuyez sur la touche **Entrer** de votre clavier 3 fois de suite (ne spécifier pas de nom de fichier, ni de phrase de passe).
![ssh_key](Resources/Readme/ssh_key.png)
3. Par défaut, les fichiers s'enregistrent dans le dossier `C:/Users/VotreNomUtilisateur/.ssh`. Vérifiez le chemin dans le message indiqué par le terminal. Si vous trouvez les fichiers `id_rsa` et `id_rsa.pub` (ou `id_ecdsa.pub` , ou `id_ed25519.pub`) dans ce dossier, votre clé SSH est créée.
### Mise en place de la clé SSH
1. Connectez-vous au site du projet https://git.zblorg.xyz/.
2. Cliquez sur votre icône de profil, en haut à droite, et cliquez sur **Settings** (Configuration).
3. Cliquez ensuite sur l'onglet **SSH / GPG Keys** (Clé SSH / GPG).
4. Dans la partie **Manage SSH Keys** (Gérer les clés SSH), cliquez sur le bouton **Add key** (Ajouter une clé).
5. Dans la partie **Content** (Contenu) qui vient d'apparaître, collez-ici l'entièreté du contenu du fichier `id_rsa.pub`, créé auparavant et se trouvant le dossier `/.ssh` de votre utilisateur. Validez ensuite en appuyant sur le bouton **Add key **(Ajouter une clé), situé en dessus du champ de texte.
![ssh_key_gittea](Resources/Readme/ssh_key_gittea.png)
### Téléchargement du projet
1. Ouvrez **GitHub Desktop**.
2. Cliquez sur `File > Clone Repository` (ou appuyez sur Ctrl+Shift+O).
3. Cliquez sur l'onglet **URL** et rentrez le l'URL SSH du dépôt du projet ainsi que le chemin où vous souhaiter installer les fichiers du projet. Vous trouverez le lien SSH sur la page du dépôt du projet https://git.zblorg.xyz/rob/Pawn (Pensez bien à cliquer sur SSH avant de copier le lien URL).
![lien_ssh](Resources/Readme/lien_ssh.png)
![Github_desktop](Resources/Readme/Github_desktop.png)
3. Cliquez sur **Clone**. Il est possible qu'on vous demande votre identifiant et mot de passe. Renseignez ceux associés au site https://git.zblorg.xyz/rob/Pawn.
4. Cliquez sur **Clone**.
4. Une fois le projet récupéré, ouvrez l'explorateur de fichier à l'endroit où sont installés les fichiers. Vous devriez voir les dossiers et fichiers suivants.
5. Une fois le projet récupéré, ouvrez l'explorateur de fichier à l'endroit où sont installés les fichiers. Vous devriez voir les dossiers et fichiers suivants.
![explorateur](Resources/Readme/explorateur.png)
5. Copiez le fichier `vars.bat` se trouvant dans le dossier `Resources`, puis collez-le dans le dossier `Pawn_Unreal`.
6. Vérifiez le chemin d'accès au moteur Unreal Engine 5.2.1 sur votre PC. Si le chemin est **identique** à celui-ci (chaque caractère compte) `C:\Program Files\Epic Games\UE_5.2`, **passez** à l'**étape 9**.
7. Si vous avez un chemin d'accès au moteur différent, ouvrez le fichiers `vars.bat` que vous avez collé dans le dossier `Pawn_Unreal` en faisant `Clique droit > Modifier`.
8. Modifiez la 10e ligne (la variable UE5_DIR) et remplacez le chemin d'accès du moteur par le votre.
6. Copiez le fichier `vars.bat` se trouvant dans le dossier `Resources`, puis collez-le dans le dossier `Pawn_Unreal`.
7. Vérifiez le chemin d'accès au moteur Unreal Engine 5.2.1 sur votre PC. Si le chemin est **identique** à celui-ci (chaque caractère compte) `C:\Program Files\Epic Games\UE_5.2`, **passez** à l'**étape 9**.
8. Si vous avez un chemin d'accès au moteur différent, ouvrez le fichiers `vars.bat` que vous avez collé dans le dossier `Pawn_Unreal` en faisant `Clique droit > Modifier`.
9. Modifiez la 10e ligne (la variable UE5_DIR) et remplacez le chemin d'accès du moteur par le votre.
![vars](Resources/Readme/vars.png)
@ -68,7 +101,12 @@ Pour récupérer le projet, je supposerai ici que vous utilisez **GitHub Desktop
------
#### Q: J'ai une erreur quand je tente d'exécuter le fichier `build_and_editor.bat`.
#### Q: Quand je tente de cloner le projet, j'ai ce message d'erreur. Que faire ?
![clone_failed](Resources/Readme/clone_failed.png)
R: Assurez-vous d'avoir bien pris l'URL SSH du projet, et non l'URL HTTPS. L'URL SSH ressemble à `git@git.zblorg.xyz:rob/Pawn.git` tandis que le lien URL HTTPS ressemble à `https://git.zblorg.xyz/rob/Pawn.git`. Le lien exacte pour cloner le dépôt sur trouve sur la page [https://git.zblorg.xyz/rob/Pawn](https://git.zblorg.xyz/rob/Pawn).
#### Q: J'ai une erreur quand je tente d'exécuter le fichier `build_and_editor.bat`. Que faire ?
![erreur](Resources/Readme/erreur.png)

BIN
Resources/Readme/Github_desktop.png (Stored with Git LFS)

Binary file not shown.

BIN
Resources/Readme/clone_failed.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
Resources/Readme/lien_ssh.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
Resources/Readme/ssh_key.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
Resources/Readme/ssh_key_gittea.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
Resources/Readme/terminal.png (Stored with Git LFS) Normal file

Binary file not shown.