git.iko.soy/obelisk
on decrease-android-validity help sign in
obelisk/lib/executable-config/README.md
39 lines 1.6 kB history raw
1# Obelisk.ExecutableConfig
3## About
5Obelisk.ExecutableConfig serves two related purposes:
71. Injection: a cross-platform injection function, which can be used to put configuration files in a canonical location.
82. Retrieval: a cross-platform retrieval function that is aware of the canonical location on each platform and how to read files from that location.
10## Supported Platforms
12| Function | iOS | Android | Warp |Web backend + GHCJS |
13|----------|:---:|:-------:|:----:|:------------------:|
14| inject | ✔ | ✔ | | ✔ |
15| get | ✔ | ✔ | ✔ | ✔ |
17### iOS and Android
19`inject` is a Nix function that copies the specified configuration folder to a canonical location on the device.
21`get` is a Haskell function that retrieves configuration files from the canonical location.
23### Warp
25There is currently no `inject` function for `jsaddle-warp`-based frontends.
27`get` is a Haskell function that simply reads the configuration files relative to the current directory.
29### Web backend + GHCJS
31#### Backend
33`inject` is a Haskell function that produces a snippet of HTML that must be appended to the `<head>` of the page that the backend serves (i.e., the entry point for the GHCJS application).
35`get` is a Haskell function that reads the configuration files relative to the current directory.
37#### GHCJS
39`get` is a Haskell function that can be run by the GHCJS frontend to retrieve the injected configuration data from the served `<head>`. There is no `inject` that is run in GHCJS.