wiki:GitHubinWiki
Last modified 5 years ago Last modified on 2014-03-05 11:40:23

Github palvelun käyttö

Tämä ohje on tarkoitettu niille kurssilaisille, joilla ei ole tunnuksia Jyväskylän yliopistoon. Ohje kertoo kuinka käytät Githubia omien pelisuunnitelmien tekemiseen Githubin wikiin.

Wikin käyttö

Github tarjoaa wikin, eli selaimen kautta muokattavan asiakirjahakemiston. Wikisivut ovat verkkosivuja, jotka sallivat käyttäjien muokata sisältöään. Kurssilla wikiä käytetään omien pelien suunnitelmien tallentamiseen. Ne kurssilaiset, jotka käyttävät Githubia versionhallintaan, käyttävät Githubin wikiä myös pelisuunnitelmiensa tallentamiseen. Yleisiä ohjeita suunnitelmien tekemiseen löydät toisaalta tästä wikistä.

Github-wikiä käytetään seuraavasti:

  • Siirry https://github.com sivuilla omaan sejypeli säiliöösi (repository).
  • Näet sivun oikeassa laidassa Wiki-linkin. Klikkaa siitä.

  • Klikkaa kerran Home-välilehteä, joka vie sinut wikin etusivulle.
  • Sivua muokataan klikkaamalla Edit Page-nappia.

  • Huom, tärkeää! Vaihda vielä muokkaustilaksi (edit mode) Creole, joka vastaa parhaiten kurssilla käytettävää wiki-merkintäkieltä

Creole on hyvin samankaltainen muokkauskieli kun kurssin wiki-ohjeessa esitelty TracWiki -merkintäkieli. Huomaa kuitenkin seuraavat poikkeavuudet:

  • Numeroitu lista tuotetaan risuaidoilla #.
    # eka
    # toka
    # kolmas
    
  • Linkit muualle nettiin, toisille wiki sivuille tai kavereiden suunnitelmaan suljetaan yhden hakasulun sijaan kahden hakasulun sisään. Voit käyttää putkimerkkiä | linkin viittauksen nimeämiseen.
    [[http://github.com|Klikkaa tästä Githubiin]]
    [[ToisenPelinWikisivu]]
    
  • Netissä tai Githubissa oleva kuva lisätään sivulle viemällä (Add+Commit) se ensin Githubiin (vaikka omaan trunk kansioosi) ja laittamalla sen raakaosoite (raw) tupla-aaltosulkeisiin. raw-osoitteen saat kun klikkaat Github säiliössäsi sinne vietyä kuvaa, napsautat raw-nappia, ja kopioit osoitteen talteen. Katso esimerkki alla:
    {{https://raw.github.com/tunnus/sejypeli/master/kuva.jpg}}
    

Voit kopioida alta Githubin wikiin valmiin rungon pelisuunnitelmallesi (copy/paste), jota täydentämällä saat tehtyä kurssilla vaaditun pelisuunnitelman omalle pelillesi:

= Suunnitelman pohja =

Tekijät:

== Tietoja pelistä ==

 * Pelin nimi:
 * Pelialusta: Windows / Xbox 360
 * Pelaajien lukumäärä: 

== Pelin tarina ==
Pelin taustatarina tai kuvaus pelin teemasta.

== Pelin idea ja tavoitteet ==
Kuvaus pelin ideasta ja tavoitteista, mitä pelissä on tarkoitus tehdä.

== Hahmotelma pelistä ==
(Liitä kuva tai kuvia paperilta skannattuna)
{{https://raw.github.com/tunnus/sejypeli/master/kuva.jpg}}

== Toteutuksen suunnitelma ==
Toteutuksen suunnitelma, mitä tekisin ja missä järjestyksessä? Millä aikataululla?

# Ensin teen...
# Sitten pistän...
# Kun edellinen toimii alan...
# jne.