diff options
| -rw-r--r-- | .travis.yml | 14 | ||||
| -rw-r--r-- | CHANGELOG.md | 11 | ||||
| -rw-r--r-- | Makefile | 6 | ||||
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | RELEASE.md | 11 | ||||
| -rw-r--r-- | doc/gf-people.md | 2 | ||||
| -rw-r--r-- | download/index-3.11.md | 57 | ||||
| -rw-r--r-- | gf.cabal | 11 | ||||
| -rw-r--r-- | index.html | 76 | ||||
| -rw-r--r-- | src/programs/gf-main.hs | 2 |
10 files changed, 107 insertions, 87 deletions
diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 0ca0794b0..000000000 --- a/.travis.yml +++ /dev/null @@ -1,14 +0,0 @@ -sudo: required - -language: c - -services: - - docker - -before_install: - - docker pull odanoburu/gf-src:3.9 - -script: - - | - docker run --mount src="$(pwd)",target=/home/gfer,type=bind odanoburu/gf-src:3.9 /bin/bash -c "cd /home/gfer/src/runtime/c && - autoreconf -i && ./configure && make && make install ; cd /home/gfer ; cabal install -fserver -fc-runtime --extra-lib-dirs='/usr/local/lib'" diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..ac209f1af --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +### New since 3.11 (WIP) + +- Added a changelog! + +### 3.11 + +See <https://www.grammaticalframework.org/download/release-3.11.html> + +### 3.10 + +See <https://www.grammaticalframework.org/download/release-3.10.html> @@ -65,6 +65,6 @@ bintar: # Make a source tar.gz distribution using git to make sure that everything is included. # We put the distribution in dist/ so it is removed on `make clean` -sdist: - test -d dist || mkdir dist - git archive --format=tar.gz --output=dist/gf-${VERSION}.tar.gz HEAD +# sdist: +# test -d dist || mkdir dist +# git archive --format=tar.gz --output=dist/gf-${VERSION}.tar.gz HEAD @@ -1,4 +1,4 @@ - + # Grammatical Framework (GF) @@ -39,7 +39,7 @@ or: stack install ``` -For more information, including links to precompiled binaries, see the [download page](http://www.grammaticalframework.org/download/index.html). +For more information, including links to precompiled binaries, see the [download page](https://www.grammaticalframework.org/download/index.html). ## About this repository diff --git a/RELEASE.md b/RELEASE.md index 04bd4b933..1deaa3a90 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -47,11 +47,14 @@ but the generated _artifacts_ must be manually attached to the release as _asset In order to do this you will need to be added the [GF maintainers](https://hackage.haskell.org/package/gf/maintainers/) on Hackage. -1. Run `make sdist` +1. Run `stack sdist --test-tarball` and address any issues. 2. Upload the package, either: - 1. **Manually**: visit <https://hackage.haskell.org/upload> and upload the file `dist/gf-X.Y.tar.gz` - 2. **via Cabal (≥2.4)**: `cabal upload dist/gf-X.Y.tar.gz` -3. If the documentation-building fails on the Hackage server, do: + 1. **Manually**: visit <https://hackage.haskell.org/upload> and upload the file generated by the previous command. + 2. **via Stack**: `stack upload . --candidate` +3. After testing the candidate, publish it: + 1. **Manually**: visit <https://hackage.haskell.org/package/gf-X.Y.Z/candidate/publish> + 1. **via Stack**: `stack upload .` +4. If the documentation-building fails on the Hackage server, do: ``` cabal v2-haddock --builddir=dist/docs --haddock-for-hackage --enable-doc cabal upload --documentation dist/docs/*-docs.tar.gz diff --git a/doc/gf-people.md b/doc/gf-people.md index 7d0ef90c2..d7b755b9d 100644 --- a/doc/gf-people.md +++ b/doc/gf-people.md @@ -7,7 +7,6 @@ title: "Grammatical Framework: Authors and Acknowledgements" The current maintainers of GF are [Krasimir Angelov](http://www.chalmers.se/cse/EN/organization/divisions/computing-science/people/angelov-krasimir), -[Thomas Hallgren](http://www.cse.chalmers.se/~hallgren/), [Aarne Ranta](http://www.cse.chalmers.se/~aarne/), [John J. Camilleri](http://johnjcamilleri.com), and [Inari Listenmaa](https://inariksit.github.io/). @@ -22,6 +21,7 @@ and The following people have contributed code to some of the versions: +- [Thomas Hallgren](http://www.cse.chalmers.se/~hallgren/) (University of Gothenburg) - Grégoire Détrez (University of Gothenburg) - Ramona Enache (University of Gothenburg) - [Björn Bringert](http://www.cse.chalmers.se/alumni/bringert) (University of Gothenburg) diff --git a/download/index-3.11.md b/download/index-3.11.md index 4f2798a0a..8fa1d5c02 100644 --- a/download/index-3.11.md +++ b/download/index-3.11.md @@ -53,26 +53,39 @@ You will probably need to update the `PATH` environment variable to include your For more information, see [Using GF on Windows](https://www.grammaticalframework.org/~inari/gf-windows.html) (latest updated for Windows 10). -<!--## Installing the latest Hackage release (macOS, Linux, and WSL2 on Windows) +## Installing from Hackage + +_Instructions applicable for macOS, Linux, and WSL2 on Windows._ [GF is on Hackage](http://hackage.haskell.org/package/gf), so under normal circumstances the procedure is fairly simple: -1. Install ghcup https://www.haskell.org/ghcup/ -2. `ghcup install ghc 8.10.4` -3. `ghcup set ghc 8.10.4` -4. `cabal update` -5. On Linux: install some C libraries from your Linux distribution (see note below) -6. `cabal install gf-3.11` - -You can also download the source code release from [GitHub](https://github.com/GrammaticalFramework/gf-core/releases), -and follow the instructions below under **Installing from the latest developer source code**. +``` +cabal update +cabal install gf-3.11 +``` ### Notes +**GHC version** + +The GF source code is known to be compilable with GHC versions 7.10 through to 8.10. + +**Obtaining Haskell** + +There are various ways of obtaining Haskell, including: + +- ghcup + 1. Install from https://www.haskell.org/ghcup/ + 2. `ghcup install ghc 8.10.4` + 3. `ghcup set ghc 8.10.4` +- Haskell Platform https://www.haskell.org/platform/ +- Stack https://haskellstack.org/ + + **Installation location** -The above steps installs GF for a single user. +The above steps install GF for a single user. The executables are put in `$HOME/.cabal/bin` (or on macOS in `$HOME/Library/Haskell/bin`), so you might want to add this directory to your path (in `.bash_profile` or similar): @@ -84,32 +97,34 @@ PATH=$HOME/.cabal/bin:$PATH GF uses [`haskeline`](http://hackage.haskell.org/package/haskeline), which on Linux depends on some non-Haskell libraries that won't be installed -automatically by cabal, and therefore need to be installed manually. +automatically by Cabal, and therefore need to be installed manually. Here is one way to do this: - On Ubuntu: `sudo apt-get install libghc-haskeline-dev` - On Fedora: `sudo dnf install ghc-haskeline-devel` -**GHC version** +## Installing from source code -The GF source code has been updated to compile with GHC versions 7.10 through to 8.8. ---> -## Installing from the latest developer source code +**Obtaining** -If you haven't already, clone the repository with: +To obtain the source code for the **release**, +download it from [GitHub](https://github.com/GrammaticalFramework/gf-core/releases). +Alternatively, to obtain the **latest version** of the source code: + +1. If you haven't already, clone the repository with: ``` git clone https://github.com/GrammaticalFramework/gf-core.git ``` - -If you've already cloned the repository previously, update with: - +2. If you've already cloned the repository previously, update with: ``` git pull ``` -Then install with: +**Installing** + +You can then install with: ``` cabal install ``` @@ -8,12 +8,17 @@ license-file: LICENSE category: Natural Language Processing, Compiler synopsis: Grammatical Framework description: GF, Grammatical Framework, is a programming language for multilingual grammar applications +maintainer: John J. Camilleri <john@digitalgrammars.com> homepage: https://www.grammaticalframework.org/ bug-reports: https://github.com/GrammaticalFramework/gf-core/issues tested-with: GHC==7.10.3, GHC==8.0.2, GHC==8.10.4 data-dir: src -extra-source-files: WebSetup.hs +extra-source-files: + README.md + CHANGELOG.md + WebSetup.hs + doc/Logos/gf0.png data-files: www/*.html www/*.css @@ -106,7 +111,7 @@ library --ghc-options: -fwarn-unused-imports --if impl(ghc>=7.8) -- ghc-options: +RTS -A20M -RTS - ghc-prof-options: -fprof-auto + -- ghc-prof-options: -fprof-auto exposed-modules: PGF @@ -370,7 +375,7 @@ executable gf if impl(ghc<7.8) ghc-options: -with-rtsopts=-K64M - ghc-prof-options: -auto-all + -- ghc-prof-options: -auto-all if impl(ghc>=8.2) ghc-options: -fhide-source-paths diff --git a/index.html b/index.html index 8816cc265..f657cc5b5 100644 --- a/index.html +++ b/index.html @@ -8,7 +8,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous"> - <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.4.2/css/all.css" integrity="sha384-/rXc/GQVaYpyDdyxK+ecHPVYJSN9bmVFBvjA/9eOB+pb3F2w2N6fc5qB9Ew5yIns" crossorigin="anonymous"> + <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.15.4/css/all.css" crossorigin="anonymous"> <link rel="alternate" href="https://github.com/GrammaticalFramework/gf-core/" title="GF GitHub repository"> </head> @@ -85,10 +85,27 @@ <div class="col-sm-6 col-md-3 mb-4"> <h3>Contribute</h3> <ul class="mb-2"> - <li><a href="http://groups.google.com/group/gf-dev">Mailing List</a></li> + <li> + <a href="https://web.libera.chat/?channels=#gf"> + <i class="fas fa-hashtag"></i> + IRC + </a> + / + <a href="https://discord.gg/EvfUsjzmaz"> + <i class="fab fa-discord"></i> + Discord + </a> + </li> + <li> + <a href="https://stackoverflow.com/questions/tagged/gf"> + <i class="fab fa-stack-overflow"></i> + Stack Overflow + </a> + </li> + <li><a href="https://groups.google.com/group/gf-dev">Mailing List</a></li> <li><a href="https://github.com/GrammaticalFramework/gf-core/issues">Issue Tracker</a></li> - <li><a href="doc/gf-people.html">Authors</a></li> <li><a href="//school.grammaticalframework.org/2020/">Summer School</a></li> + <li><a href="doc/gf-people.html">Authors</a></li> </ul> <a href="https://github.com/GrammaticalFramework/" class="btn btn-primary ml-3"> <i class="fab fa-github mr-1"></i> @@ -154,7 +171,7 @@ least one, it may help you to get a first idea of what GF is. <div class="row"> <div class="col-md-6"> - <h2>Applications & Availability</h2> + <h2>Applications & availability</h2> <p> GF can be used for building <a href="//cloud.grammaticalframework.org/translator/">translation systems</a>, @@ -219,19 +236,28 @@ least one, it may help you to get a first idea of what GF is. or <a href="https://www.grammaticalframework.org/irc/?C=M;O=D">browse the channel logs</a>. </p> <p> - If you have a larger question which the community may benefit from, we recommend you ask it on the <a href="http://groups.google.com/group/gf-dev">mailing list</a>. + There is also a <a href="https://discord.gg/EvfUsjzmaz">GF server on Discord</a>. + </p> + + <p> + For bug reports and feature requests, please create an issue in the + <a href="https://github.com/GrammaticalFramework/gf-core/issues">GF Core</a> or + <a href="https://github.com/GrammaticalFramework/gf-rgl/issues">RGL</a> repository. + + For programming questions, consider asking them on <a href="https://stackoverflow.com/questions/tagged/gf">Stack Overflow with the <code>gf</code> tag</a>. + If you have a more general question to the community, we recommend you ask it on the <a href="http://groups.google.com/group/gf-dev">mailing list</a>. </p> </div> <div class="col-md-6"> <h2>News</h2> - <dt class="col-sm-3 text-center text-nowrap">2021-07-25</dt> - <dd class="col-sm-9"> - <strong>GF 3.11 released.</strong> - <a href="download/release-3.11.html">Release notes</a> - </dd> <dl class="row"> + <dt class="col-sm-3 text-center text-nowrap">2021-07-25</dt> + <dd class="col-sm-9"> + <strong>GF 3.11 released.</strong> + <a href="download/release-3.11.html">Release notes</a> + </dd> <dt class="col-sm-3 text-center text-nowrap">2021-05-05</dt> <dd class="col-sm-9"> <a href="https://cloud.grammaticalframework.org/wordnet/">GF WordNet</a> now supports languages for which there are no other WordNets. New additions: Afrikaans, German, Korean, Maltese, Polish, Somali, Swahili. @@ -244,34 +270,6 @@ least one, it may help you to get a first idea of what GF is. <dd class="col-sm-9"> <a href="https://www.mitpressjournals.org/doi/pdf/10.1162/COLI_a_00378">Abstract Syntax as Interlingua</a>: Scaling Up the Grammatical Framework from Controlled Languages to Robust Pipelines. A paper in Computational Linguistics (2020) summarizing much of the development in GF in the past ten years. </dd> - <dt class="col-sm-3 text-center text-nowrap">2018-12-03</dt> - <dd class="col-sm-9"> - <a href="//school.grammaticalframework.org/2018/">Sixth GF Summer School</a> in Stellenbosch (South Africa), 3–14 December 2018 - </dd> - <dt class="col-sm-3 text-center text-nowrap">2018-12-02</dt> - <dd class="col-sm-9"> - <strong>GF 3.10 released.</strong> - <a href="download/release-3.10.html">Release notes</a> - </dd> - <dt class="col-sm-3 text-center text-nowrap">2018-07-25</dt> - <dd class="col-sm-9"> - The GF repository has been split in two: - <a href="https://github.com/GrammaticalFramework/gf-core">gf-core</a> and - <a href="https://github.com/GrammaticalFramework/gf-rgl">gf-rgl</a>. - The original <a href="https://github.com/GrammaticalFramework/GF">GF</a> repository is now archived. - </dd> - <dt class="col-sm-3 text-center text-nowrap">2017-08-11</dt> - <dd class="col-sm-9"> - <strong>GF 3.9 released.</strong> - <a href="download/release-3.9.html">Release notes</a> - </dd> - <dt class="col-sm-3 text-center text-nowrap">2017-06-29</dt> - <dd class="col-sm-9"> - GF is moving to <a href="https://github.com/GrammaticalFramework/GF/">GitHub</a>.</dd> - <dt class="col-sm-3 text-center text-nowrap">2017-03-13</dt> - <dd class="col-sm-9"> - <a href="//school.grammaticalframework.org/2017/">GF Summer School</a> in Riga (Latvia), 14-25 August 2017 - </dd> </dl> <h2>Projects</h2> @@ -341,7 +339,7 @@ least one, it may help you to get a first idea of what GF is. Libraries are at the heart of modern software engineering. In natural language applications, libraries are a way to cope with thousands of details involved in syntax, lexicon, and inflection. The - <a href="lib/doc/synopsis/index.html">GF resource grammar library</a> has + <a href="lib/doc/synopsis/index.html">GF resource grammar library</a> (RGL) has support for an increasing number of languages, currently including Afrikaans, Amharic (partial), diff --git a/src/programs/gf-main.hs b/src/programs/gf-main.hs index 1dae54bc7..cf387d2fa 100644 --- a/src/programs/gf-main.hs +++ b/src/programs/gf-main.hs @@ -1,3 +1,5 @@ +module Main where + import qualified GF main = GF.main |