summaryrefslogtreecommitdiff
path: root/installation.mdwn
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2019-08-24 09:56:33 +0100
committerLars Wirzenius <liw@liw.fi>2019-08-24 09:56:33 +0100
commita4fe99dce874ffb8fcc8a426fe9ce967f126b264 (patch)
tree79ad9437fe7605147a0c09b858a39d5d3efe59ef /installation.mdwn
parent0e4298faf31142707bf481a4c64c93aace6d11dd (diff)
downloadfable.liw.fi-a4fe99dce874ffb8fcc8a426fe9ce967f126b264.tar.gz
Add: installation instructions
Diffstat (limited to 'installation.mdwn')
-rw-r--r--installation.mdwn41
1 files changed, 41 insertions, 0 deletions
diff --git a/installation.mdwn b/installation.mdwn
new file mode 100644
index 0000000..ce486fb
--- /dev/null
+++ b/installation.mdwn
@@ -0,0 +1,41 @@
+[[!meta title="Installation instructions"]]
+
+Fable is packaged only for Debian unstable.
+
+Installing Debian for Debian unstable
+=============================================================================
+
+Add the following to your APT sources lists:
+
+```
+deb http://ci-prod-controller.vm.liw.fi/debian unstable-ci main
+```
+
+Then run the following commands:
+
+```sh
+apt update
+apt install fable
+```
+
+
+Running Fable from git
+=============================================================================
+
+To run Fable from git, you need to clone the git repository and need
+Python 3, and the Markdown parser installed, as well as document
+typesetting tools, from Debian 10 (buster) or later:
+
+```sh
+sudo apt update
+sudo apt install make git locales-all pandoc python3 \
+ python3-pandocfilters python3-commonmark-bkrs python3-yaml \
+ texlive-latex-base texlive-fonts-recommended \
+ graphviz librsvg2-bin
+git clone git://git.liw.fi/fable-poc
+cd fable-poc
+```
+
+Note that `fable-poc` contains sample versions of the files for the
+echo acceptance tests (`echo.md`, `echo.yaml`, `echo.py`, and
+`echo-prelude.py`) so that you don't need to type them in yourself.