docs: improve readability (#63)

- Improve readability of the documentation
- Improve Markdown consistency
- Add more headings to clarify the document structure
- Add syntax types to code blocks to improve Markdown rendering
- Add mention that Git is required as a system wide dependency
This commit is contained in:
Daniel Schildt
2020-01-23 19:29:59 +02:00
committed by Riku Rouvila
parent 52dc8a09e3
commit 87f45af570

View File

@@ -6,39 +6,52 @@
**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:
* toiminnallisuuteen
* designiin
* [HTTP-rajapintaan](https://github.com/koodiklinikka/koodiklinikka.fi-api)
* projektin hallintaan liittyviin asioihin
* tai koko Koodiklinikkaan yleisesti.
- toiminnallisuuteen
- designiin
- [HTTP-rajapintaan](https://github.com/koodiklinikka/koodiklinikka.fi-api)
- projektin hallintaan liittyviin asioihin
- tai koko Koodiklinikkaan yleisesti.
-----------------------------
## Projektin asennus
### Vaaditut työkalut
- Asenna [Node.js](http://nodejs.org)
- Kloonaa projekti koneellesi:
- Asenna [Git](https://git-scm.com/) client lähdekoodin hallintaan
```
git clone https://github.com/koodiklinikka/koodiklinikka.fi.git
### Kloonaa projekti koneellesi
```sh
git clone https://github.com/koodiklinikka/koodiklinikka.fi.git
```
- Käynnistä kehitystila:
### Käynnistä kehitystila
```
cd koodiklinikka.fi
npm install
npm start
```sh
cd koodiklinikka.fi
npm install
npm start
```
- Avaa selaimessasi: [`http://localhost:3000`](http://localhost:3000)
### Avaa esikatselu selaimessa
Avaa selaimessasi: [`http://localhost:3000`](http://localhost:3000)
## Komennot
* `npm install`
* asentaa projektin riippuvuudet
* `npm start`
* kääntää lähdetiedostot ja palvelee sovellusta porttiin `3000`
* `npm run build`
* kääntää lähdetiedostot -> `out/`
### `npm install`
Asentaa projektin riippuvuudet
### `npm start`
Kääntää lähdetiedostot ja palvelee sovellusta porttiin `3000`
### `npm run build`
Kääntää lähdetiedostot -> `out/` -hakemistoon