File tree Expand file tree Collapse file tree 2 files changed +43
-37
lines changed Expand file tree Collapse file tree 2 files changed +43
-37
lines changed Original file line number Diff line number Diff line change @@ -6,46 +6,10 @@ This is an introductory tutorial to **servant**. Whilst browsing is fine, it mak
6
6
Any comments, issues or feedback about the tutorial can be submitted
7
7
to `servant's issue tracker <http://github.com/haskell-servant/servant/issues >`_.
8
8
9
- cabal-install
10
- --------
11
-
12
- The whole tutorial is a `cabal <https://cabal.readthedocs.io/en/latest/ >`_
13
- project and can be built locally as follows:
14
-
15
- .. code-block :: bash
16
-
17
- $ git clone https://github.com/haskell-servant/servant.git
18
- $ cd servant
19
- # build
20
- $ cabal new-build tutorial
21
- # load in ghci to play with it
22
- $ cabal new-repl tutorial
23
-
24
- stack
25
- --------
26
-
27
- The servant `stack <https://docs.haskellstack.org/en/stable/README/ >`_ template includes the working tutorial. To initialize this template, run:
28
-
29
- .. code-block :: bash
30
-
31
- $ stack new myproj servant
32
- $ cd myproj
33
- # build
34
- $ stack build
35
- # start server
36
- $ stack exec myproj-exe
37
-
38
- The code can be found in the `*.lhs ` files under `doc/tutorial/ ` in the
39
- repository. Feel free to edit it while you're reading this documentation and
40
- see the effect of your changes.
41
-
42
- `Nix <https://nixos.org/nix/ >`_ users should feel free to take a look at
43
- the `nix/shell.nix ` file in the repository and use it to provision a suitable
44
- environment to build and run the examples.
45
-
46
9
.. toctree ::
47
10
:maxdepth: 1
48
11
12
+ install.rst
49
13
ApiType.lhs
50
14
Server.lhs
51
15
Client.lhs
Original file line number Diff line number Diff line change
1
+ Install
2
+ ========
3
+
4
+ cabal-install
5
+ --------
6
+
7
+ The whole tutorial is a `cabal <https://cabal.readthedocs.io/en/latest/ >`_
8
+ project and can be built locally as follows:
9
+
10
+ .. code-block :: bash
11
+
12
+ $ git clone https://github.com/haskell-servant/servant.git
13
+ $ cd servant
14
+ # build
15
+ $ cabal new-build tutorial
16
+ # load in ghci to play with it
17
+ $ cabal new-repl tutorial
18
+
19
+ stack
20
+ --------
21
+
22
+ The servant `stack <https://docs.haskellstack.org/en/stable/README/ >`_ template includes the working tutorial. To initialize this template, run:
23
+
24
+ .. code-block :: bash
25
+
26
+ $ stack new myproj servant
27
+ $ cd myproj
28
+ # build
29
+ $ stack build
30
+ # start server
31
+ $ stack exec myproj-exe
32
+
33
+ The code can be found in the `*.lhs ` files under `doc/tutorial/ ` in the
34
+ repository. Feel free to edit it while you're reading this documentation and
35
+ see the effect of your changes.
36
+
37
+ nix
38
+ --------
39
+
40
+ `Nix <https://nixos.org/nix/ >`_ users should feel free to take a look at
41
+ the `nix/shell.nix ` file in the repository and use it to provision a suitable
42
+ environment to build and run the examples.
You can’t perform that action at this time.
0 commit comments