diff options
author | Yann Herklotz Grave <git@yannherklotzgrave.com> | 2019-02-24 22:34:21 +0000 |
---|---|---|
committer | Yann Herklotz Grave <git@yannherklotzgrave.com> | 2019-02-24 22:34:21 +0000 |
commit | 8a8a3ef4157ab796a484665b8107f68582423414 (patch) | |
tree | 1bf5dc7eafea11d01a0a3ba0ec269f641ed1c7a4 /README.md | |
parent | 436da9f2bc85459cc6517ec21ebcf6171520e019 (diff) | |
download | median-cut-8a8a3ef4157ab796a484665b8107f68582423414.tar.gz median-cut-8a8a3ef4157ab796a484665b8107f68582423414.zip |
Clarifying the code in Main.hs and add to readme
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 27 |
1 files changed, 26 insertions, 1 deletions
@@ -1 +1,26 @@ -# median-cut +# Median Cut + +To compile and run, one has to first download +[stack](https://docs.haskellstack.org/en/stable/README/) + +The simplest way to do this is by executing the following command: + +``` +curl -sSL https://get.haskellstack.org/ | sh +``` + +Then run setup in this directory: + +``` +stack setup +``` + +Finally the executable can be built and run using the following: + +``` +stack build --exec mirror-ball +``` + +This project relies on a open source library that I wrote to load +PFM files which is hosted at [PFM](https://github.com/ymherklotz/pfm). +It will automatically get downloaded when built with stack. |