summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Elsdörfer <michael@elsdoerfer.info>2020-06-14 17:46:06 +0100
committerMichael Elsdörfer <michael@elsdoerfer.info>2020-06-14 17:46:06 +0100
commit74f3f7a38479e50856e8f04cad53072d9b17603f (patch)
treee29de7538355aaf2eb9c7d940178f25702b237db
parent3fe8c3109f0aa1b597c9e919c9eac7cad47675f3 (diff)
Update documentation.
-rw-r--r--doc/gf-developers.t2t2
-rw-r--r--download/index.md14
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/gf-developers.t2t b/doc/gf-developers.t2t
index 74059199b..ed336b9a7 100644
--- a/doc/gf-developers.t2t
+++ b/doc/gf-developers.t2t
@@ -391,6 +391,8 @@ bindings are found in the ``src/runtime/python`` and ``src/runtime/java``
directories, respecively. Compile them by following the instructions in
the ``INSTALL`` files in those directories.
+The Python library can also be installed from PyPI using `pip install pgf`.
+
== Compilation of RGL ==
As of 2018-07-26, the RGL is distributed separately from the GF compiler and runtimes.
diff --git a/download/index.md b/download/index.md
index e6a1d39bc..44eb6db3c 100644
--- a/download/index.md
+++ b/download/index.md
@@ -171,6 +171,20 @@ in the RGL folder.
This assumes that you already have GF installed.
For more details about building the RGL, see the [RGL README](https://github.com/GrammaticalFramework/gf-rgl/blob/master/README.md).
+## Installing the Python bindings from PyPI
+
+The Python library is available on PyPI as `pgf`, so it can be installed using:
+
+```
+pip install pgf
+```
+
+We provide binary wheels for Linux and OSX (with Windows missing so far), which
+include the C runtime and a ready-to-go. If there is no binary distribution for
+your platform, this will install the source tarball, which will attempt to build
+the binding during installation, and requires the GF C runtime to be installed on
+your system.
+
## Older releases
- [GF 3.9](index-3.9.html) (August 2017)