git.iko.soy/streamly
on master help sign in
Move the "install haskell" part to "before-you-begin"
commit5814bceb5f6618867dd41a6eaa5e47ab6b2725ca authorHarendra Kumar <harendra@composewell.com> dateFri 17 Mar 2023, 03:39 (4 years ago) parent9541caf
2 files changed+24−24
compare with master
unifiedsplit
docs/User/Tutorials/before-you-begin.md+22−3 docs/User/Tutorials/setup-and-usage.md+2−21
docs/User/Tutorials/before-you-begin.md+22−3
@@ -9,10 +9,29 @@ In this tutorial, we assume basic knowledge of Haskell syntax, constructs and
99lazy evaluation. The [Haskell wikibook](https://en.wikibooks.org/wiki/Haskell)
1010may be a good place to start and get familiar with Haskell.
1111
12+## Installing Haskell
13+
1214If you wish to follow along and run the examples in this tutorial, you will
13−need to have [Streamly][] installed. Please see the [Setup and
14−Usage](/docs/User/Tutorials/setup-and-usage.md) guide for instructions
15−on how to install and use [Streamly][].
15+need to have Haskell tool chain installed.
16+
17+You can choose one of the following sections.
18+
19+### Haskell Toolchain
20+
21+To get started, you will need a fairly recent version (last three major
22+versions will work) of the Haskell compiler `ghc` and the build tool
23+`cabal` installed on your system. Please see the install instructions
24+at https://www.haskell.org/downloads/ .
25+
26+### Development Environment using Nix
27+
28+If you use the nix package manager, a nix shell for complete
29+development environment - including a consistent set of latest streamly
30+ecosystem packages, hoogle documentation, vim and vscode editors,
31+Haskell language server (HLS) and other tools - is available at
32+[streamly-packages][streamly-packages].
33+
34+## Building for Performance
1635
1736If you wish to run benchmarks, please be sure to build your
1837application using the instructions in the [Build Guide](/docs/User/HowTo/Compiling.md).
docs/User/Tutorials/setup-and-usage.md+2−21
@@ -6,8 +6,8 @@ SPDX-License-Identifer: BSD-3-Clause
66
77# Getting started with `Haskell Streamly`
88
9−This guide shows you how to install Haskell and the `streamly` package,
10−and then use Streamly in a simple program.
9+This guide shows you how to use Streamly in `ghci` REPL, a simple
10+program or a Haskell project.
1111
1212<!-- TODO: Add instructions for `stack` and `nix`.
1313
@@ -20,25 +20,6 @@ running Windows&trade; then you may need to run a command-line shell
2020under `msys` and some of the commands below may also need to be changed
2121in small ways to make them work.
2222
23−## Installing Haskell
24−
25−You can choose one of the following options.
26−
27−### Installing the Haskell Toolchain
28−
29−To get started, you will need a fairly recent version (last three major
30−versions will work) of the Haskell compiler `ghc` and the build tool
31−`cabal` installed on your system. Please see the install instructions
32−at https://www.haskell.org/downloads/ .
33−
34−### Development Environment using Nix
35−
36−If you use the nix package manager, a nix shell for complete
37−development environment - including a consistent set of latest streamly
38−ecosystem packages, hoogle documentation, vim and vscode editors,
39−Haskell language server (HLS) and other tools - is available at
40−[streamly-packages][streamly-packages].
41−
4223## Using `streamly` Interactively in REPL
4324
4425You can try out `streamly` using `GHCi`, the interactive Haskell