on master help sign in
Make section titles more specific

In the setup-and-usage guide. Make minor edits, merge pre-req section.

commit201c07d61d0d99ea9b1d37491240aa92c8439d6c authorHarendra Kumar <harendra@composewell.com> dateFri 3 Mar 2023, 15:14 (4 years ago) parent2bb1b3d
1 file changed+12−8
docs/User/Tutorials/setup-and-usage.md+12−8
docs/User/Tutorials/setup-and-usage.md+12−8
@@ -6,10 +6,8 @@ SPDX-License-Identifer: BSD-3-Clause
66
77# Getting started with `Haskell Streamly`
88
9−This guide shows you how to write a simple program that uses
10−[Streamly][].
11−
12−## Pre-requisites
9+This guide shows you how to install Haskell and the `streamly` package,
10+and then use Streamly in a simple program.
1311
1412<!-- TODO: Add instructions for `stack` and `nix`.
1513
@@ -22,14 +20,18 @@ running Windows&trade; then you may need to run a command-line shell
2220under `msys` and some of the commands below may also need to be changed
2321in small ways to make them work.
2422
25−### Installing Haskell
23+## Installing Haskell
24+
25+You can choose one of the following options.
26+
27+### Installing the Haskell Toolchain
2628
2729To get started, you will need a fairly recent version (last three major
2830versions will work) of the Haskell compiler `ghc` and the build tool
2931`cabal` installed on your system. Please see the install instructions
3032at https://www.haskell.org/downloads/ .
3133
32−### Complete Development Environment
34+### Development Environment using Nix
3335
3436If you use the nix package manager, a nix shell for complete
3537development environment - including a consistent set of latest streamly
@@ -103,6 +105,8 @@ Create a project directory for our example project.
103105$ mkdir streamly-project
104106```
105107
108+### Add `streamly` as project dependency
109+
106110Run `cabal init` in the project directory to create an initial set of
107111project files:
108112
@@ -127,7 +131,7 @@ on `.cabal` files.
127131This invocation also creates a skeletal `app/Main.hs` file which we
128132will now use to write our streamly based program.
129133
130−### Use `streamly` in the Project Code
134+### Import `streamly` modules in the project code
131135
132136Let us now turn the single-line stanza we used in the REPL into a
133137standalone program.
@@ -154,7 +158,7 @@ $ cabal run
1541583
155159```
156160
157−### Running the project in GHCi REPL
161+### Running GHCi REPL for the project code
158162
159163To start up the GHCi REPL for your project, please use:
160164