git.iko.soy/streamly
on master help sign in
Make some edits, add a pointer to compilation options
e954d17Harendra Kumar
INSTALL.md+17−16
compare with master
unifiedsplit
@@ -1,15 +1,15 @@
1# Using `streamly` package
1# Using `streamly` package
2
2
3−The latest stable release of the package is available
4−[on Hackage](https://hackage.haskell.org/package/streamly). You can also try
3+* [Latest stable release](https://hackage.haskell.org/package/streamly) is available on
5−the latest development version
4+ Hackage.
6−[from github](https://github.com/composewell/streamly).
5+* [Latest development version](https://github.com/composewell/streamly) is
6+ available on github.
7+* See [recommeded compilation options here](docs/Build.md).
7
8
8−The default version available to you and how to pick a specific version may
9+If you are using `stack` or `nix` please make sure to add the latest version
9−depend on the build tool you are using. We have provided instructions to use a
10+from Hackage to your tool configuration.
10−specific version for some tools below.
11
11
12−## cabal
12+## Using with `cabal`
13
13
14Make sure you have `cabal` version 2.4 or later installed and you have `ghc`
14Make sure you have `cabal` version 2.4 or later installed and you have `ghc`
15available in your PATH. Refresh your package list:
15available in your PATH. Refresh your package list:
@@ -18,19 +18,20 @@ available in your PATH. Refresh your package list:
18$ cabal v2-update
18$ cabal v2-update
19```
19```
20
20
21−### hackage version in repl
21+### Using hackage version in repl
22
22
23```
23```
24−# Pick the latest version on Hackage
24+# Run repl with the latest version from Hackage
25$ cabal v2-repl --build-depends streamly
25$ cabal v2-repl --build-depends streamly
26
26
27−# Pick a specific version on Hackage
27+# Run repl with a specific version from Hackage
28$ cabal v2-repl --build-depends streamly==0.6.1
28$ cabal v2-repl --build-depends streamly==0.6.1
29```
29```
30
30
31−### github version in repl
31+### Using github version in repl
32
32
33+Create a directory for your playground (e.g. `test`) and create a
33−Create a `test` directory and create a `cabal.project` file in it as follows:
34+`cabal.project` file in it as follows:
34
35
35```
36```
36packages: .
37packages: .
@@ -40,7 +41,7 @@ source-repository-package
40 tag: master
41 tag: master
41```
42```
42
43
43−Create a `test.cabal` file as follows
44+Create a cabal file (e.g. `test.cabal`) as follows
44
45
45```
46```
46cabal-version: 2.4
47cabal-version: 2.4
@@ -57,7 +58,7 @@ Run repl:
57$ cabal v2-repl
58$ cabal v2-repl
58```
59```
59
60
60−### ghc
61+### Compiling with ghc
61
62
62```
63```
63$ cat hello.hs
64$ cat hello.hs
@@ -71,7 +72,7 @@ $ cabal v2-install streamly-0.6.1
71$ ghc -package streamly-0.6.1 hello.hs
72$ ghc -package streamly-0.6.1 hello.hs
72```
73```
73
74
74−### Project
75+### Using in a Project
75
76
76Add `streamly` to the `build-depends` section of your library/executable in
77Add `streamly` to the `build-depends` section of your library/executable in
77your `<package>.cabal` file. Appropriate version from Hackage will be picked
78your `<package>.cabal` file. Appropriate version from Hackage will be picked