diff --git a/README.org b/README.org index 1ac9555..e872ae6 100644 --- a/README.org +++ b/README.org @@ -2,10 +2,37 @@ #+author: Annwan #+options: h:0 num:nil toc:nil -** TODO List [4/4] -- [X] Framework -- [X] Time table [2/2] - - [X] =edt= command - - [X] Messages in channel -- [X] Reminders -- [X] Group join +** TODO List +- [ ] Reminders + +** Setup + +*** Prerequisites + +- [[https://docs.haskellstack.org/en/stable/README/][The Haskell tool stack]] ([[./stack-arm.org][installing stack on ARM64]]) + +*** Building + +#+begin_src sh +git clone 'https://git.annwan.me/Annwan/botiut' +cd botiut +stack setup +stack build +#+end_src + +*** Configuring + +- Put your discord token in =auth.secret= in the working directory, + without trailing new lines + +- Put the yaml format configuration in =conf.yaml=. An commented + configuration example is given in [[./conf.example.yaml][conf.example.yaml]]. + +*** Running + +There is two options + +1) Run =stack run= from the repository + +2) Copy the executable somewhere else, then call it from the expected + working directory. diff --git a/stack-arm.org b/stack-arm.org new file mode 100644 index 0000000..319cba6 --- /dev/null +++ b/stack-arm.org @@ -0,0 +1,25 @@ +#+title: Installing stack on ARM64 +#+author: Annwan +#+date: 2022:03:04 +#+options: h:1 num:nil toc:nil + +** Why stack on ARM + +People might want to run haskell applications on ARM devices like a +Raspberry Pi. The Haskell compiler has supported the architecture +through LLVM for a couple of year now, as well as the builtin dependency +manager, Cabal. However the dependency management of Cabal is +system-wide (or at least user wide) and, because all packages interact +with each other, it can pose problems with compatibility. + +That is the problem that =stack= solves by allowing for reproducible, +isolated environement for each project, and a lot of projects now use +stack for their dependency and version management. + +However stack does not provide any build for arm systems, we thus need +to install it anoter way + +** Contents + +#+TOC: headlines 1 +