-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update and rename README.org to README.md
- Loading branch information
Showing
2 changed files
with
34 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`. |
This file was deleted.
Oops, something went wrong.