unison/README.md
Rebecca 7380c1ecaf
Update README.md
minor update
2021-07-06 15:04:42 -07:00

53 lines
2.8 KiB
Markdown

The Unison language
===================
[![Build Status](https://travis-ci.org/unisonweb/unison.svg?branch=master)](https://travis-ci.org/unisonweb/unison)
[Unison](https://unisonweb.org) is a new programming language, currently under active development. It's a modern, statically-typed purely functional language, similar to Haskell, but with the ability to describe entire distributed systems with a single program. Here's an example of a distributed map-reduce implementation:
```Haskell
-- comments start with `--`
mapReduce loc fn ifEmpty reduce data = match split data with
Empty -> ifEmpty
One a -> fn a
Two left right ->
fl = at loc '(mapReduce loc fn ifEmpty reduce !left)
fr = at loc '(mapReduce loc fn ifEmpty reduce !right)
reduce !fl !fr
```
This function can be either simulated locally (possibly with faults injected for testing purposes), or run atop a distributed pool of compute.
If you'd like to learn more about the project, [this Strange Loop talk is a good introduction](https://www.youtube.com/watch?v=gCWtkvDQ2ZI). You can also follow along with [project website](https://unisonweb.org) or you can also say hello or lurk [in the Slack chat](https://unisonweb.org/slack).
We are currently alpha testing Unison. If you'd like to participate in alpha testing, you can go to [the docs site](https://www.unisonweb.org/docs) to get started.
Building using Stack
--------------------
If these instructions don't work for you or are incomplete, please file an issue.
The build uses [Stack](http://docs.haskellstack.org/). If you don't already have it installed, [follow the install instructions](http://docs.haskellstack.org/en/stable/README.html#how-to-install) for your platform. (Hint: `brew update && brew install stack`)
```sh
$ git clone https://github.com/unisonweb/unison.git
$ cd unison
$ stack --version # we'll want to know this version if you run into trouble
$ stack build && stack exec tests && stack exec unison
```
To run a local codebase-ui while building from source, you can use the `/dev-ui-install.sh` script. It will download the latest release of the codebase-ui and put it in the expected location for the unison executable created by `stack build`. When you start unison, you'll see a url where the codebase-ui is running.
See [`development.markdown`](development.markdown) for a list of build commands you'll likely use during development.
Codebase Server
---------------
When `ucm` starts it starts a Codebase web server that is used by the
[Codebase UI](https://github.com/unisonweb/codebase-ui). It selects a random
port and a unique token that must be used when starting the UI to correctly
connect to the server.
The port, host and token can all be configured by providing environment
variables when starting `ucm`: `UCM_PORT`, `UCM_HOST`, and `UCM_TOKEN`.