From 60422ea8884edd1c204e195d71b7aafab432ae46 Mon Sep 17 00:00:00 2001 From: Dougal Maclaurin Date: Fri, 4 Oct 2019 15:10:13 -0400 Subject: [PATCH] Update readme --- README.md | 42 ++++++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 800e20c71..a6a679a52 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,33 @@ -Setup -===== +# Dex -- Install [stack](https://www.haskellstack.org) -- Install LLVM 7, e.g. `apt-get install llvm-7-dev` +Dex (short for "index") is a research language for array processing in the +Haskell/ML family. The goal of the project is to explore questions about: -Building -======== + * Type systems for array programming + * Mathematical program transformations like differentiation and integration + * User-directed compilation to parallel hardware + * Interactive and incremental numerical programming and visualization -- Build Dex `make` (or `make-no-web` on non-Linux) -- Run tests: `make tests` -- Set up alias (e.g. in .bashrc) `alias dex=stack exec dex --` +To learn more, check out our +[workshop paper](https://openreview.net/pdf?id=rJxd7vsWPS) +or look at these example programs: -Running -======= + * [Tutorial](examples/tutorial.dx) + * [Mandelbrot set](examples/mandelbrot.dx) -- Traditional REPL: `dex repl` -- Execute script: `dex script example/tutorial.dx` -- Notebook interface: `dex web example/tutorial.dx` +## Setup + + * Install [stack](https://www.haskellstack.org) + * Install LLVM 7, e.g. `apt-get install llvm-7-dev` + +## Building + + * Build Dex `make` (or `make-no-web` on non-Linux) + * Run tests: `make tests` + * Set up alias (e.g. in .bashrc) `alias dex=stack exec dex --` + +## Running + + * Traditional REPL: `dex repl` + * Execute script: `dex script example/tutorial.dx` + * Notebook interface: `dex web example/tutorial.dx`