From 1cd3455f28f3d94489c31790947af168f8598426 Mon Sep 17 00:00:00 2001 From: Daniel Schildt Date: Thu, 10 Nov 2016 16:08:56 +0200 Subject: [PATCH] docs(README.md) improve documentation - Improve documentation structure. - Improve Markdown syntax to make it more readable. --- README.md | 34 +++++++++++++++++++++------------- 1 file changed, 21 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 766340c..6669ab4 100644 --- a/README.md +++ b/README.md @@ -5,32 +5,40 @@ **Koodiklinikka.fi lähdekoodi**. [Issueita](https://github.com/koodiklinikka/koodiklinikka.fi/issues) ja [Pull Requestejä](https://github.com/koodiklinikka/koodiklinikka.fi/pulls) otetaan lämpimästi vastaan. Yritämme pitää kynnyksen kontribuoida projektiin alhaisena, jotta mahdollisimman moni pääsisi jättämään siihen jälkensä. Kaikki koodi katselmoidaan läpi ja mergetään projektiin kun näyttää hyvälle. Muutamasta mergetystä Pull Requestista oikeudet ylläpitää projektia. -[Issueita](https://github.com/koodiklinikka/koodiklinikka.fi/issues) voidaan käyttää myös sivun +[Issueita](https://github.com/koodiklinikka/koodiklinikka.fi/issues) voidaan käyttää myös sivun: * toiminnallisuuteen * designiin * [HTTP-rajapintaan](https://github.com/koodiklinikka/koodiklinikka.fi-api) * projektin hallintaan liittyviin asioihin - -Tai koko Koodiklinikkaan yleisesti. +* tai koko Koodiklinikkaan yleisesti. ----------------------------- ## Projektin asennus -- Asenna [Node.js](http://nodejs.org) -``` +- Asenna [Node.js](http://nodejs.org) +- Kloonaa projekti koneellesi: + + ``` git clone git@github.com:koodiklinikka/koodiklinikka.fi.git - cd koodiklinikka.fi - npm install - npm start - avaa http://localhost:9001 selaimessasi ``` +- Käynnistä kehitystila: + + ``` + cd koodiklinikka.fi + npm install + npm start +``` + +- Avaa selaimessasi: [`http://localhost:9001`](http://localhost:9001) + + ## Komennot -* npm install +* `npm install` * asentaa projektin riippuvuudet -* npm start - * kääntää lähdetiedostot ja palvelee sovellusta porttiin 9001 -* npm run build +* `npm start` + * kääntää lähdetiedostot ja palvelee sovellusta porttiin `9001` +* `npm run build` * kääntää lähdetiedostot