From 3fc5eb8ef804cf6ce88fc91ff9fa0325be74cb7f Mon Sep 17 00:00:00 2001
From: Saku Laesvuori <saku@laesvuori.fi>
Date: Sat, 7 Sep 2024 21:14:35 +0300
Subject: [PATCH] =?UTF-8?q?Lis=C3=A4=C3=A4=20README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c58a069
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+# Kululaskusilppuri
+
+Kululaskusilppuri pilkkoo ja siistii [kululaskut.fi](https://kululaskut.fi):n
+tuottamia CSV-tiedostoja OMS:n kirjanpitoon helpommin tuotavaan muotoon. Se
+poistaa tiedoista käyttämättömät kentät, siistii loput
+[Kitsaalla](https://kitsas.fi) luettavaan muotoon ja pilkkoo rivit erillisiin
+tiedostoihin maksupäivien perusteella.
+
+## Asentaminen
+
+Lisää tämä git-tietovaranto [Guixin kanavalistaan][guix-channels]
+seuraavankaltaisella pätkällä:
+
+[guix-channels]: https://guix.gnu.org/manual/devel/en/guix.html#Specifying-Additional-Channels
+
+```lisp
+(channel
+ (name 'kululaskusilppuri)
+ (url "https://git.olarinmaensamoojat.fi/OMS/kululaskusilppuri")
+ (branch "main")
+ (introduction
+  (make-channel-introduction
+   "4a4d0add212aab3554689adb7971bc0b0db32d13"
+   (openpgp-fingerprint
+    "A0C9 1947 734F 076F 5F08 E9FF 257D 284A 2A1D 3A32"))))
+```
+
+Tämän jälkeen Kululaskusilppuri on saatavilla `kululaskusilppuri`-nimisenä
+pakettina kaikkialla Guixissa. Voit esimerkiksi ottaa sen käyttöön
+komentotulkkisessioosi komennolla `guix shell kululaskusilppuri`.
+
+## Ajaminen
+
+Yleensä kululaskusilppurin käyttö etenee seuraavasti:
+
+1. Lataa uudet kululaskut CSV-tiedostona osoitteesta
+   <https://hallinta.kululaskut.fi>
+2. Aja `kululaskusilppuri`
+3. Vie Kululaskusilppurin luomat CSV-tiedostot Kitsaaseen
+
+Jokaiselle komennolle tarvitsee määrittää oikeat asetukset komentorivillä
+annettavilla valitsimilla. Mahdolliset valitsimet voi listata kirjoittamalla
+komennon perään `--help`-valitsimen.
+
+## Kehittäminen
+
+Kehitysympäristön saat helposti Guixilla ajamalla komennon [`guix
+shell`][guix-shell] tässä hakemistossa. Muutoksia, vikailmoituksia ja
+kehitysideoita voi jättää Giteassa tai sähköpostilla osoitteeseen
+<saku@laesvuori.fi>. Tarkista, että kululaskusilppuri kääntyy vielä muutostesi
+jälkeen ajamalla komento `guix time-machine -C channels.scm -- build -f
+guix.scm`.
+
+[guix-shell]: https://guix.gnu.org/manual/devel/en/guix.html#Invoking-guix-shell
+
+## Kopioiminen
+
+Laskutin on [GNU AGPL lisenssin version kolme](COPYING.md), tai valintasi
+mukaan minkä tahansa myöhemmän [Free Software Foundationin julkaiseman
+version][fsf-agpl], alainen vapaa ohjelma, eli se kunniottaa käyttäjiensä
+vapautta päättää itse omasta tietojenkäsittelystään ja auttaa toisiaan.
+
+[fsf-agpl]: https://www.gnu.org/licenses/agpl-3.0.html