Skip to content

Commit

Permalink
Update and rename README.org to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cstml authored Jun 22, 2021
1 parent 5f77672 commit 15c88f1
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 3 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# FMCt

Typed Functional Machine Calculus.

The project is in active development, and there will be many breaking changes.

With that being said, I will try and correctly note the versions of each.

## Building

To build there are two ways, depending on which you prefer:

### With Nix

1. pull the repo,
2. run: `nix-build release.nix && ./result/bin/FMCt`,
3. you are in the repl,
4. Have fun!

### With Cabal

1. pull the repo,
2. run: `cabal new-build && cabal run`,
3. you are in the repl,
4. have fun!

#### With GNUMake

- this will just use the NIX, but might update later.

## Examples

To play with examples, have a look in the source files as there are examples
sprinkled around. Especially in `src-exe/Examples.hs`.
3 changes: 0 additions & 3 deletions README.org

This file was deleted.

0 comments on commit 15c88f1

Please sign in to comment.