diff options
| author | John J. Camilleri <john@digitalgrammars.com> | 2020-07-11 21:06:08 +0200 |
|---|---|---|
| committer | John J. Camilleri <john@digitalgrammars.com> | 2020-07-11 21:06:08 +0200 |
| commit | 38f468eed3325d5e435021b8b137f80545f22a95 (patch) | |
| tree | f495fbbadcdcae993108b022278861fbb955c3f4 /src/runtime/haskell-bind/README | |
| parent | 88a73c1d9e9e9bf1ac4c4194917e50df1bcce635 (diff) | |
(pgf2) Readme, license, changelog
Diffstat (limited to 'src/runtime/haskell-bind/README')
| -rw-r--r-- | src/runtime/haskell-bind/README | 46 |
1 files changed, 0 insertions, 46 deletions
diff --git a/src/runtime/haskell-bind/README b/src/runtime/haskell-bind/README deleted file mode 100644 index 60251e653..000000000 --- a/src/runtime/haskell-bind/README +++ /dev/null @@ -1,46 +0,0 @@ -# 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 - -## 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) -``` - -## Changelog - -### 1.1.0 - -Remove SG library. - -### 1.0.0 - -Everything up until 2020-07-11. |