docs: add readme

This commit is contained in:
Youwen Wu 2024-08-16 06:40:37 -07:00
parent 2bf47c02ec
commit e86fbe9d5a
Signed by: youwen5
GPG key ID: 865658ED1FE61EC3

13
README.md Normal file
View file

@ -0,0 +1,13 @@
# Suntheme
runs a script on sunrise and sunset, written in pure haskell.
You may be wondering how a program written in Haskell, the purely functional
programming language, could possibly act on the real world by running a so-called "script".
It's simple. We take in the entire World as an input to a pure function, the IO Monad.
It then maps the original World to the changed World, with our desired IO actions carefully applied.
> From the second perspective, an IO action transforms the whole world. IO actions are actually pure, because they receive a unique world as an argument and then return the changed world.
See [this](https://lean-lang.org/functional_programming_in_lean/monads/io.html) for more information.