summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMeowyam <maryam@chilon.net>2021-07-14 15:34:56 +0800
committerInari Listenmaa <inari.listenmaa@gmail.com>2021-07-14 15:32:02 +0800
commit6f2a4bcd2c7efa3bc878a8309bc11cc09101fbf5 (patch)
tree031a6a9ed51d4fdeb0c94d5960302b84a5bf6b92 /doc
parentf345f615f417ff92f56b2b2fe412513d25109ec0 (diff)
update doc for linux installation
Diffstat (limited to 'doc')
-rw-r--r--doc/gf-developers.t2t52
1 files changed, 22 insertions, 30 deletions
diff --git a/doc/gf-developers.t2t b/doc/gf-developers.t2t
index d7cd44083..b4a21a25e 100644
--- a/doc/gf-developers.t2t
+++ b/doc/gf-developers.t2t
@@ -15,52 +15,28 @@ you are a GF user who just wants to download and install GF
== Setting up your system for building GF ==
To build GF from source you need to install some tools on your
-system: the //Haskell Platform//, //Git// and the //Haskeline library//.
+system: the Haskell Tool Stack, //Git// and the //Haskeline library//.
**On Linux** the best option is to install the tools via the standard
software distribution channels, i.e. by using the //Software Center//
in Ubuntu or the corresponding tool in other popular Linux distributions.
-Or, from a Terminal window, the following command should be enough:
-- On Ubuntu: ``sudo apt-get install haskell-platform git libghc6-haskeline-dev``
-- On Fedora: ``sudo dnf install haskell-platform git ghc-haskeline-devel``
+If the Haskell Tool Stack is already installed, enter the following command in a Terminal:
+- On Ubuntu: ``sudo apt-get install git libghc6-haskeline-dev``
+- On Fedora: ``sudo dnf install git ghc-haskeline-devel``
**On Mac OS and Windows**, the tools can be downloaded from their respective
web sites, as described below.
-=== The Haskell Platform ===
-
-GF is written in Haskell, so first of all you need
-the //Haskell Platform//, e.g. version 8.0.2 or 7.10.3. Downloads
-and installation instructions are available from here:
-
- http://hackage.haskell.org/platform/
-
-Once you have installed the Haskell Platform, open a terminal
-(Command Prompt on Windows) and try to execute the following command:
-```
-$ ghc --version
-```
-This command should show you which version of GHC you have. If the installation
-of the Haskell Platform was successful you should see a message like:
-
-```
-The Glorious Glasgow Haskell Compilation System, version 8.0.2
-```
-
-Other required tools included in the Haskell Platform are
-[Cabal http://www.haskell.org/cabal/],
-[Alex http://www.haskell.org/alex/]
-and
-[Happy http://www.haskell.org/happy/].
-
=== Git ===
To get the GF source code, you also need //Git//.
//Git// is a distributed version control system, see
https://git-scm.com/downloads for more information.
+If you've entered the command above, it incudes git installation.
+
=== The haskeline library ===
GF uses //haskeline// to enable command line editing in the GF shell.
@@ -149,6 +125,17 @@ It is also possible for anyone else to contribute by
- and finally sending a pull request.
+== Compilation from source with Stack ==
+
+Assuming you have the Haskell Tool Stack, Git, and Haskeline installed, entering
+
+```
+$ stack install
+```
+
+into a Terminal will install GF and all necessary libraries, including Alex and Happy.
+
+
== Compilation from source with Cabal ==
@@ -424,6 +411,11 @@ extra-lib-dirs:
- /usr/local/lib
```
+First you will need to install the following libraries if not already installed:
+
+```
+apt-get install
+
and then run ``stack install``, also from the top directory.