summaryrefslogtreecommitdiff
path: root/src/runtime/haskell-bind/README
diff options
context:
space:
mode:
authorJohn J. Camilleri <john@johnjcamilleri.com>2020-08-03 10:53:51 +0200
committerGitHub <noreply@github.com>2020-08-03 10:53:51 +0200
commite10bb790cb257bc025e6256cd8c8a6bbba542754 (patch)
tree89678b42b9a703d67d25eebe1cf394797d994585 /src/runtime/haskell-bind/README
parent830dbe760db2df0c573c06cb481d0611bf55908b (diff)
parentc53353f08763fbbfb5c0abeaa03da6a23aa64080 (diff)
Merge pull request #69 from GrammaticalFramework/pgf2-hackage
Update pgf2 metadata for uploading to Hackage Even though this isn't able to package the C runtime itself into the Haskell package, I think these changes are still worth merging into master.
Diffstat (limited to 'src/runtime/haskell-bind/README')
-rw-r--r--src/runtime/haskell-bind/README26
1 files changed, 0 insertions, 26 deletions
diff --git a/src/runtime/haskell-bind/README b/src/runtime/haskell-bind/README
deleted file mode 100644
index 4782c2d37..000000000
--- a/src/runtime/haskell-bind/README
+++ /dev/null
@@ -1,26 +0,0 @@
-This is a binding to the new GF 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
-
-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:
-
- 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)