Skip to content

Commit 242cdcf

Browse files
authored
Update installation instructions (#195)
* update install instructions some dates * change when to install c runtime manually
1 parent 052916b commit 242cdcf

File tree

2 files changed

+25
-34
lines changed

2 files changed

+25
-34
lines changed

download/index-3.12.md

Lines changed: 24 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
title: Grammatical Framework Download and Installation
3-
date: 3 August 2025
3+
date: 8 August 2025
44
---
55

6-
**GF 3.12** was released on 3 August 2025.
6+
**GF 3.12** was released on 8 August 2025.
77

88
What's new? See the [release notes](release-3.12.html).
99

1010
#### Note: GF core and the RGL
1111

1212
The following instructions explain how to install **GF core**, i.e. the compiler, shell and run-time systems.
13-
Obtaining the **Resource Grammar Library (RGL)** is done separately; see the section at the bottom of this page.
13+
Obtaining the **Resource Grammar Library (RGL)** is done separately; see the section [at the bottom of this page](#installing-the-rgl-from-a-binary-release).
1414

1515
---
1616

@@ -21,24 +21,19 @@ Binary packages are available for Debian/Ubuntu, macOS, and Windows and include:
2121
- GF shell and grammar compiler
2222
- `gf -server` mode
2323
- C run-time system
24-
- Java & Python bindings to the C run-time system
25-
26-
Unlike in previous versions, the binaries **do not** include the RGL.
24+
- Python bindings to the C run-time system
2725

2826
[Binary packages on GitHub](https://github.com/GrammaticalFramework/gf-core/releases/tag/3.12)
2927

3028
#### Debian/Ubuntu
3129

32-
There are two versions: `gf-3.12-ubuntu-18.04.deb` for Ubuntu 18.04 (Cosmic), and `gf-3.12-ubuntu-20.04.deb` for Ubuntu 20.04 (Focal).
33-
34-
To install the package use:
30+
The package targets Ubuntu 24.04 (Noble).
31+
To install it, use:
3532

3633
```
37-
sudo apt-get install ./gf-3.12-ubuntu-*.deb
34+
sudo apt install ./gf-3.12-ubuntu-24.04.deb
3835
```
3936

40-
<!-- The Ubuntu `.deb` packages should work on Ubuntu 16.04, 18.04 and similar Linux distributions. -->
41-
4237
#### macOS
4338

4439
To install the package, just double-click it and follow the installer instructions.
@@ -47,9 +42,10 @@ The packages should work on at least Catalina and Big Sur.
4742

4843
#### Windows
4944

50-
To install the package, unpack it anywhere.
45+
To install the package:
5146

52-
You will probably need to update the `PATH` environment variable to include your chosen install location.
47+
1. unpack it anywhere and take note of the full path to the folder containing the `.exe` file.
48+
2. add it to the `PATH` environment variable
5349

5450
For more information, see [Using GF on Windows](https://www.grammaticalframework.org/~inari/gf-windows.html) (latest updated for Windows 10).
5551

@@ -67,23 +63,22 @@ cabal install gf-3.12
6763

6864
### Notes
6965

70-
**GHC version**
66+
#### GHC version
7167

72-
The GF source code is known to be compilable with GHC versions 7.10 through to 8.10.
68+
The GF source code is known to be compilable with GHC versions 7.10 through to 9.6.7.
7369

74-
**Obtaining Haskell**
70+
#### Obtaining Haskell
7571

7672
There are various ways of obtaining Haskell, including:
7773

7874
- ghcup
79-
1. Install from https://www.haskell.org/ghcup/
80-
2. `ghcup install ghc 8.10.4`
81-
3. `ghcup set ghc 8.10.4`
82-
- Haskell Platform https://www.haskell.org/platform/
83-
- Stack https://haskellstack.org/
75+
1. Install from https://www.haskell.org/ghcup/
76+
2. `ghcup install ghc 9.6.7`
77+
3. `ghcup set ghc 9.6.7`
78+
- Stack: https://haskellstack.org/
8479

8580

86-
**Installation location**
81+
#### Installation location
8782

8883
The above steps install GF for a single user.
8984
The executables are put in `$HOME/.cabal/bin` (or on macOS in `$HOME/Library/Haskell/bin`),
@@ -93,7 +88,7 @@ so you might want to add this directory to your path (in `.bash_profile` or simi
9388
PATH=$HOME/.cabal/bin:$PATH
9489
```
9590

96-
**Haskeline**
91+
#### Haskeline
9792

9893
GF uses [`haskeline`](http://hackage.haskell.org/package/haskeline), which
9994
on Linux depends on some non-Haskell libraries that won't be installed
@@ -105,7 +100,7 @@ Here is one way to do this:
105100

106101
## Installing from source code
107102

108-
**Obtaining**
103+
### Obtaining
109104

110105
To obtain the source code for the **release**,
111106
download it from [GitHub](https://github.com/GrammaticalFramework/gf-core/releases).
@@ -121,8 +116,7 @@ git clone https://github.com/GrammaticalFramework/gf-core.git
121116
git pull
122117
```
123118

124-
125-
**Installing**
119+
### Installing
126120

127121
You can then install with:
128122
```
@@ -139,8 +133,6 @@ stack install
139133
For more info on working with the GF source code, see the
140134
[GF Developers Guide](../doc/gf-developers.html).
141135

142-
For macOS Sequoia, you need to downgrade the LLVM package, see instructions [here](https://github.com/GrammaticalFramework/gf-core/issues/172#issuecomment-2599365457).
143-
144136
## Installing the Python bindings from PyPI
145137

146138
The Python library is available on PyPI as `pgf`, so it can be installed using:
@@ -149,10 +141,7 @@ The Python library is available on PyPI as `pgf`, so it can be installed using:
149141
pip install pgf
150142
```
151143

152-
We provide binary wheels for Linux and macOS, which include the C runtime and are ready-to-go.
153-
If there is no binary distribution for your platform, this will install the source tarball,
154-
which will attempt to build the binding during installation,
155-
and requires the GF C runtime to be installed on your system.
144+
If this doesn't work, you will need to install the C runtime manually; see the instructions [here](https://www.grammaticalframework.org/doc/gf-developers.html#toc12).
156145

157146
---
158147

@@ -164,6 +153,8 @@ In general the steps to follow are:
164153
1. Download a binary release and extract it somewhere on your system.
165154
2. Set the environment variable `GF_LIB_PATH` to point to wherever you extracted the RGL.
166155

156+
For more information, see [Using GF on Windows](https://www.grammaticalframework.org/~inari/gf-windows.html) (latest updated for Windows 10).
157+
167158
## Installing the RGL from source
168159

169160
To compile the RGL, you will need to have GF already installed and in your path.

download/release-3.12.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: GF 3.12 Release Notes
3-
date: 03 August 2025
3+
date: 08 August 2025
44
---
55

66
## Installation

0 commit comments

Comments
 (0)