LESSON 6: GITHUB & GIT
INTRODUCTION
Je hebt in de afgelopen lessen je eigen character ontwikkeld. In deze laatste les ga je je character loslaten in de environment. Dit werkt met behulp van GitHub, dus het eerste wat je moet doen is een account aanmaken op GitHub.
GitHub is een website waar je zogenaamde git repositories op kunt slaan. Een git repository is simpel gezegd een verzameling bestanden waarvan verschillende versies worden bijgehouden. GitHub maakt het makkelijk om code online te zetten, samen te werken met andere developers en bij te dragen aan opensource projecten. Download vervolgens de GitHub app voor Mac of voor Windows. Werk je met Linux? Er zijn verschillende GUI tools beschikbaar zoals gitk, maar als je al gewend bent aan de command line interface is het aan te raden git vanaf de command line te gebruiken. Dit kan overigens ook op Mac en Windows. Mocht je meer over Git willen weten, dit online boek is een uitstekende referentie. In deze les gaan we alleen in op Mac en Windows, maar er zijn veel goede tutorials over git en GitHub op het internet te vinden (bijvoorbeeld deze).
Git is een versiebeheer-systeem (Wikipedia). In het kort houdt dat in dat je verschillende versies van bestanden kan bewaren. Dit kunnen tekstbestanden zijn, Processing sketches, afbeeldingen, 3D modellen en eigenlijk elk ander type bestand. Eén van de grootste voordelen van versie beheer systemen is dat je op elk moment terug kan naar een vorige versie van je project. Je kunt dus bijvoorbeeld experimenteren met een nieuw stuk code, zonder bang te zijn dat je iets kapot maakt. Je hoeft nooit meer een map te kopiëren en op te slaan als ‘project_1.9’ of iets dergelijks, git houdt alles voor je bij.
Nadat je een repository of project hebt aangemaakt is de workflow ongeveer als volgt:
Verander iets in je code
Leg deze veranderingen vast in een commit
Herhaal stap 1 en 2 zo lang als nodig
Push de commits naar GitHub (of een andere server zoals Bitbucket of je eigen server)
STAP 1
Nadat je de GitHub app hebt geïnstalleerd kun je inloggen met je zojuist aangemaakte GitHub account. Log in met je gegevens. Voer vervolgens je naam en e-mail adres in, deze zullen worden toegevoegd aan al je commits.
Mac gebruikers: Als je git nog niet eerder geïnstalleerd hebt of je weet het niet meer zeker, klik dan op ‘Install Command Line Tools’ om dit alsnog te doen. Als de wizard aangeeft dat git al geïnstalleerd is kun je op ‘skip’ klikken.
STAP 2
Nu de instellingen compleet zijn kun je je eerste repository aanmaken. Klik linksboven in beeld op het plus-icoon en vul de naam van de repository en de map waar je de repository op wilt slaan in. Klik op ‘create repository’. Open nu in de map die je zojuist ingevuld hebt met Finder of Explorer (of klik met je rechtermuisknop op de repository en selecteer ‘Show in Finder’ / ‘Open in Explorer’).
STAP 3
Maak nu een nieuw tekstbestand aan, plak je character code er in en sla deze op als ‘Classnaam.pde’ in de map van de repository, vervang 'Classnaam' hier door de naam van jouw class. Het is een goed idee om je eigen naam als deel van je classnaam te gebruiken om te voorkomen dat er verschillende characters met dezelfde classnaam in de environment komen.
Mac gebruikers:
Werk je op Mac in TextEdit? Klik dan in het menu Format op ‘Make Plain Text’ om alle opmaak te verwijderen.
Als je nu de GitHub app weer opent zul je zien dat het programma ziet dat je iets veranderd hebt; je hebt namelijk een bestand toegevoegd. (Windows: klik naast ‘Uncommitted changes’ op ‘Show’.) Vul nu bij ‘Summary’ een korte omschrijving in van wat je gedaan hebt, bijvoorbeeld ‘Added the character file’. Bij ‘Description’ kun je een langere omschrijving geven maar je mag dit ook leeg laten. Zorg er voor dat ‘Select all’ aangevinkt is en klik op ‘Commit’ (Windows: ‘Commit to master’) om een nieuwe commit te maken. Je hebt de verandering nu vastgelegd.
STAP 4
Om de repository beschikbaar te maken op GitHub klik je rechtsboven op ‘Publish’ (Windows: ‘Publish Repository’). De eerste keer dat je dit doet moet je de naam van de repository invullen (deze kan op GitHub anders zijn dan op je eigen computer) en een omschrijving van de repository. Hier vul ik nu bijvoorbeeld in: 'This repository holds my character for the Play&Learn course by FIBER and MU. See http://playnlearn.codedmatters.com for more information.' Klik nu op ‘Push Repository’ om het proces af te ronden. Als je nu naar GitHub gaat en ingelogd bent zul je zien dat er een repository van jouw naam verschenen is. Klik op de naam om de repository te bekijken. Je kunt nu bijvoorbeeld het .pde bestand bekijken en ook de commit die je net gepusht hebt. Als je meer commits toevoegt kun je ook alle versies van je bestanden bekijken.
STAP 5
Je bent bijna klaar om je character aan de omgeving toe te voegen. Voordat je je character uploadt moet je er alleen nog voor zorgen dat jouw character class de 'Creature' class als zijn superclass heeft:class MyAwesomeCreature extends Creature { … }