summaryrefslogtreecommitdiff
path: root/doc/gf-developers.t2t
diff options
context:
space:
mode:
authorhallgren <hallgren@chalmers.se>2014-06-17 14:17:59 +0000
committerhallgren <hallgren@chalmers.se>2014-06-17 14:17:59 +0000
commit6f8e52c944e807eb5e122b35b68dfafc20b6c54f (patch)
tree6e0e3b9ff1e5a9a64b5a74770748f8369d583395 /doc/gf-developers.t2t
parent1668eb17e5b14fa64cac069c53250aadb50d5e9b (diff)
doc/gf-developers.t2t: quick note on how to compile the C run-time system
Also a few other minor updates.
Diffstat (limited to 'doc/gf-developers.t2t')
-rw-r--r--doc/gf-developers.t2t34
1 files changed, 27 insertions, 7 deletions
diff --git a/doc/gf-developers.t2t b/doc/gf-developers.t2t
index 3dba43508..82e02cb50 100644
--- a/doc/gf-developers.t2t
+++ b/doc/gf-developers.t2t
@@ -40,7 +40,7 @@ web sites, as described below.
=== The Haskell Platform ===
GF is written in Haskell, so first of all you need
-the //Haskell Platform//, version 2012.4.0.0. Downloads
+the //Haskell Platform//, version 2012.4.0.0 or 2013.2.0.0. Downloads
and installation instructions are available from here:
http://hackage.haskell.org/platform/
@@ -54,12 +54,12 @@ 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 7.4.2
+The Glorious Glasgow Haskell Compilation System, version 7.6.3
```
Other required tools included in the Haskell Platform are
-[Cabal http://www.haskell.org/cabal/]
-%,[Alex http://www.haskell.org/alex/]
+[Cabal http://www.haskell.org/cabal/],
+[Alex http://www.haskell.org/alex/]
and
[Happy http://www.haskell.org/happy/].
@@ -79,7 +79,7 @@ This should work automatically on MacĀ OS and Windows, but on Linux one
extra step is needed to make sure the C libraries required by //haskeline//
are installed. Here is one way to do this:
-- On Ubuntu: ``sudo apt-get install libghc6-haskeline-dev``
+- On Ubuntu: ``sudo apt-get install libghc-haskeline-dev``
- On Fedora: ``sudo yum install ghc-haskeline-devel``
@@ -401,10 +401,30 @@ $ make clean
%$ make sdist
%```
+== Compiling GF with C run-time system support ==
+
+The C run-time system is separate implementation of the PGF run-time services
+that makes it possible to work with very large, ambiguous grammars, using
+probabilistic models to obtain probable parses.
+
+Support for calling the C run-time library is available in the web API
+provided by ``gf -server``, if C run-time support is enabled.
+
+To enable the C run-time system, first go to the ``src/runtime/c`` directory
+and follow the instructions in the ``INSTALL`` file to install the C run-time
+system. Once this is done, you can install GF with C run-time support by
+doing
+
+```
+cabal install -fserver -fc-runtime
+```
+from the top directory.
+
+
== Creating .deb packages for Ubuntu ==
-This has been tested on Ubuntu 12.04, and the resulting ``.deb`` packages
-appears to work on Ubuntu 12.04, 12.10 and 13.04.
+This was tested on Ubuntu 14.04 for the release of GF 3.6, and the
+resulting ``.deb`` packages appears to work on Ubuntu 12.04, 13.10 and 14.04.
Under Ubuntu, Haskell executables are statically linked against other Haskell
libraries, so the .deb packages are fairly self-contained.