diff options
| author | John J. Camilleri <john@digitalgrammars.com> | 2020-07-11 20:00:25 +0200 |
|---|---|---|
| committer | John J. Camilleri <john@digitalgrammars.com> | 2020-07-11 20:00:25 +0200 |
| commit | 88a73c1d9e9e9bf1ac4c4194917e50df1bcce635 (patch) | |
| tree | 9ff097d3f230cc2b8709d9858138602f96d35bf2 /src/runtime | |
| parent | f54e54123c41750510f856d596724db739239123 (diff) | |
Bump pgf2 to 1.1.0, update README
Diffstat (limited to 'src/runtime')
| -rw-r--r-- | src/runtime/haskell-bind/README | 50 | ||||
| -rw-r--r-- | src/runtime/haskell-bind/pgf2.cabal | 2 |
2 files changed, 36 insertions, 16 deletions
diff --git a/src/runtime/haskell-bind/README b/src/runtime/haskell-bind/README index 4782c2d37..60251e653 100644 --- a/src/runtime/haskell-bind/README +++ b/src/runtime/haskell-bind/README @@ -1,26 +1,46 @@ -This is a binding to the new GF runtime in C. +# PGF2 + +This is a Haskell binding to the PGF runtime in C. The files are: -PGF2.hsc -- a user API similar to Python and Java APIs -PGF2/FFI.hs -- an internal module with FFI definitions for - -- the relevant C functions +- PGF2.hsc: a user API similar to Python and Java APIs +- PGF2/FFI.hs: an internal module with FFI definitions for the relevant C functions -HOW TO COMPILE: +## How to compile +``` cabal install +``` + +**Note:** you must have the PGF C runtime already installed and available. +See <https://github.com/GrammaticalFramework/gf-core/blob/master/src/runtime/c/INSTALL> + +## How to use + +Import PGF to the Haskell program that you're writing. +The Cabal infrastructure will make sure to tell the compiler +where to find the relevant modules. + +## Example + +```haskell +module Main where + +import PGF2 +import qualified Data.Map as Map + +main = do + pgf <- readPGF "Foo.pgf" + let Just english = Map.lookup "FooEng" (languages pgf) +``` -HOW TO USE: +## Changelog -- Import PGF to the Haskell program that you're writing. - The Cabal infrastructure will make sure to tell the compiler - where to find the relevant modules. Example: +### 1.1.0 - module Main where +Remove SG library. - import PGF2 - import qualified Data.Map as Map +### 1.0.0 - main = do - pgf <- readPGF "Foo.pgf" - let Just english = Map.lookup "FooEng" (languages pgf) +Everything up until 2020-07-11. diff --git a/src/runtime/haskell-bind/pgf2.cabal b/src/runtime/haskell-bind/pgf2.cabal index 75b6e8a76..9e1e1e393 100644 --- a/src/runtime/haskell-bind/pgf2.cabal +++ b/src/runtime/haskell-bind/pgf2.cabal @@ -1,5 +1,5 @@ name: pgf2 -version: 1.0.0 +version: 1.1.0 synopsis: Bindings to the Grammatical Framework C runtime description: GF, Grammatical Framework, is a programming language for multilingual grammar applications. |