Lisää README

This commit is contained in:
Saku Laesvuori 2025-07-19 11:03:47 +03:00
parent bf06f917a6
commit fc607b763f
Signed by: slaesvuo
GPG Key ID: 257D284A2A1D3A32

44
README.md Normal file
View File

@ -0,0 +1,44 @@
# TITO
Tito on Haskell-kirjasto TITO-muotoisten tiliotteiden lukemiseen.
## 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 'ghc-tito)
(url "https://git.olarinmaensamoojat.fi/OMS/tito")
(branch "main")
(introduction
(make-channel-introduction
"a793f511921f1e962ca0fdc9d988dfe26b4dc6b4"
(openpgp-fingerprint
"A0C9 1947 734F 076F 5F08 E9FF 257D 284A 2A1D 3A32"))))
```
Tämän jälkeen Tito on saatavilla `ghc-tito`-nimisenä pakettina kaikkialla
Guixissa.
## 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ä Tito 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