aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOndřej Čertík <ondrej@certik.us>2020-02-25 10:15:57 -0800
committerOndřej Čertík <ondrej@certik.us>2020-02-25 10:25:18 -0800
commitbbb021b74fc7009fe905b0015ad4cca85bfe0a0d (patch)
tree91da3b783c4494f2e7c3df07cc037848386374e4 /README.md
parent3b988c733521dedbfa4a775222edc3b6abd166a9 (diff)
downloadfpm-bbb021b74fc7009fe905b0015ad4cca85bfe0a0d.tar.gz
fpm-bbb021b74fc7009fe905b0015ad4cca85bfe0a0d.zip
Update README with Haskell instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 17 insertions, 20 deletions
diff --git a/README.md b/README.md
index e6e23c1..b767268 100644
--- a/README.md
+++ b/README.md
@@ -4,29 +4,26 @@ A prototype version.
## How to try it out
-Install Rust, then:
-```
-cargo build
-```
-Go to a test directory and execute:
+### Install Haskell
+
+Install Haskell Stack from (https://haskellstack.org/). E.g., to install on
+Linux without root access, follow the [manual download](https://docs.haskellstack.org/en/stable/install_and_upgrade/#manual-download_2):
```
-cd tests/1
-../../target/debug/fpm build
-../../target/debug/fpm run
+wget https://get.haskellstack.org/stable/linux-x86_64-static.tar.gz
+tar xaf linux-x86_64-static.tar.gz
```
-And the same in the other test directory (one can also call `run` directly):
+and put the `stack` binary in your path, for example by:
```
-cd tests/2
-../../target/debug/fpm run
+export PATH="$PATH:`pwd`/stack-2.1.3-linux-x86_64-static/"
```
-## Development Details
-
-The command line interface (CLI) program `fpm` is build according to the
-following Rust CLI tutorial:
-
-https://rust-cli.github.io/book/index.html
+### Build and Test FPM
-and the user API is inspired by Cargo. Here is Cargo project layout:
-
-https://doc.rust-lang.org/cargo/guide/project-layout.html
+Build using:
+```
+stack build
+```
+To test:
+```
+stack test
+```