From 0406218ff9eced76b665ec857f783cf11dd127ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vili=20Sinerv=C3=A4?= Date: Fri, 7 Oct 2022 17:55:56 +0300 Subject: [PATCH] Kirjoita ohje --- README.md | 2 ++ dokumentaatio/ohje.md | 20 ++++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 dokumentaatio/ohje.md diff --git a/README.md b/README.md index 35d072d..b5ecccb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Markov musiikkigeneraattori ## Dokumentaatio +[Ohje](https://github.com/ArcticCoder/markov-music-generator/blob/main/dokumentaatio/ohje.md) + [Määrittelydokumentti](https://github.com/ArcticCoder/markov-music-generator/blob/main/dokumentaatio/maarittelydokumentti.md) [Testausdokumentti](https://github.com/ArcticCoder/markov-music-generator/blob/main/dokumentaatio/testausdokumentti.md) diff --git a/dokumentaatio/ohje.md b/dokumentaatio/ohje.md new file mode 100644 index 0000000..3dd6435 --- /dev/null +++ b/dokumentaatio/ohje.md @@ -0,0 +1,20 @@ +# Asentaminen +Vaihtoehtoisesti voi luoda virtuaaliympäristön ennen asennusta. Tämä on vahvasti suositeltavaa, sillä näin projektin vaatimat kirjastot pysyvät erillään muusta järjestelmästä. Virtuaaliympäristön voi luoda esimerkiksi `venv`-nimiseen kansioon projektin juureen komennolla + +`python3 -m venv venv` + +Tämän jälkeen ympäristön saa käytöön komennolla + +`source venv/bin/activate` + +Ohjelman vaatimat kirjastot voi asentaa komennolla + +`pip install -r requirements.txt` + +Ohjelma on nyt valmis käytettäväksi. + +# Opetusdata +Opetusdataksi kelpaa mikä tahansa MIDI-tiedosto, mutta itse olen käyttänyt MuseScore-palvelua tietyillä [hakukriteereillä](https://musescore.com/sheetmusic?instrument=2&instrumentation=114&license=to_share&recording_type=public-domain). Ainoa rajoitus on se, että ohjelma jättää huomiotta molli-sävellajeissa (minor key signature) olevat osat. Laadun parantamiseksi jokaisessa MIDI-tiedoston raidassa ("track") olisi hyvä olla vain yksi melodia. Edellä olevasta linkistä löytyvät tiedostot ovat olleet sopivia, joten se on varma valinta, jos olet epävarma. + +# MIDI-tiedostojen toistaminen +Monet ohjelmat kykenevät toistamaan MIDI-tiedostoja. Esimerkiksi Windows media player, Totem ja VLC (lisäosilla). Näihin löytyy monia yksinkertaisia ohjeita netistä, joten en selosta tässä enempää.