Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dougalm committed Oct 4, 2019
1 parent fe24d12 commit 60422ea
Showing 1 changed file with 28 additions and 14 deletions.
42 changes: 28 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`

0 comments on commit 60422ea

Please sign in to comment.