mirror of
https://github.com/GrammaticalFramework/gf-core.git
synced 2026-05-21 09:02:50 -06:00
Minimal update with new repo URLs & build instructions
This commit is contained in:
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
# Grammatical Framework (GF)
|
# Grammatical Framework (GF)
|
||||||
|
|
||||||
[](https://travis-ci.org/GrammaticalFramework/GF)
|
[](https://travis-ci.org/GrammaticalFramework/gf-core)
|
||||||
|
|
||||||
The Grammatical Framework is a grammar formalism based on type theory.
|
The Grammatical Framework is a grammar formalism based on type theory.
|
||||||
It consists of:
|
It consists of:
|
||||||
|
|||||||
@@ -105,24 +105,23 @@ GF then you should consider getting read-write access.
|
|||||||
|
|
||||||
==== Getting a fresh copy for read-only access ====
|
==== Getting a fresh copy for read-only access ====
|
||||||
|
|
||||||
Anyone can get the latest development version of GF by running (all on one line):
|
Anyone can get the latest development version of GF by running:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ git clone https://github.com/GrammaticalFramework/GF.git
|
$ git clone https://github.com/GrammaticalFramework/gf-core.git
|
||||||
|
$ git clone https://github.com/GrammaticalFramework/gf-rgl.git
|
||||||
```
|
```
|
||||||
|
|
||||||
This will create a directory called ``GF`` in the current
|
This will create directories ``gf-core`` and ``gf-rgl`` in the current directory.
|
||||||
directory.
|
|
||||||
|
|
||||||
|
|
||||||
==== Updating your copy ====
|
==== Updating your copy ====
|
||||||
|
|
||||||
To get all new patches from the main repo:
|
To get all new patches from each repo:
|
||||||
```
|
```
|
||||||
$ git pull
|
$ git pull
|
||||||
```
|
```
|
||||||
This can be done anywhere in your local repository, i.e. in the ``gf``
|
This can be done anywhere in your local repository.
|
||||||
directory, or any of its subdirectories.
|
|
||||||
|
|
||||||
|
|
||||||
==== Recording local changes ====[record]
|
==== Recording local changes ====[record]
|
||||||
@@ -153,30 +152,6 @@ you can use the flag ``-a`` to automatically record //all// modified
|
|||||||
files. You still need to use ``git add`` to add new files.
|
files. You still need to use ``git add`` to add new files.
|
||||||
|
|
||||||
|
|
||||||
%==== Submitting patches ====
|
|
||||||
%
|
|
||||||
%If you are using read-only access, send your patches by email to
|
|
||||||
%someone with write-access. First record your changes in your local
|
|
||||||
%repository, as described above. You can send any number of recorded
|
|
||||||
%patches as one patch bundle. You create the patch bundle with:
|
|
||||||
%
|
|
||||||
%```
|
|
||||||
%$ darcs send -o mypatch.patch
|
|
||||||
%$ gzip mypatch.patch
|
|
||||||
%```
|
|
||||||
%
|
|
||||||
%(where ``mypatch`` is hopefully replaced by a slightly more
|
|
||||||
%descriptive name). Since some e-mail setups change text attachments
|
|
||||||
%(most likely by changing the newline characters) you need to send
|
|
||||||
%the patch in some compressed format, such as GZIP, BZIP2 or ZIP.
|
|
||||||
%
|
|
||||||
%Send it as an e-mail attachment.
|
|
||||||
%% If you have
|
|
||||||
%%sendmail or something equivalent installed, it is possible to send the
|
|
||||||
%%patch directly from darcs. If so, replace ``-o mypatch.patch`` with
|
|
||||||
%%``--to=EMAIL`` where ``EMAIL`` is the address to send it to.
|
|
||||||
|
|
||||||
|
|
||||||
=== Read-write access ===
|
=== Read-write access ===
|
||||||
|
|
||||||
If you are a member of the GF project on GitHub, you can push your
|
If you are a member of the GF project on GitHub, you can push your
|
||||||
@@ -203,7 +178,7 @@ case, all you need to do to compile and install GF, after downloading the
|
|||||||
source code as described above, is
|
source code as described above, is
|
||||||
|
|
||||||
```
|
```
|
||||||
$ cd gf
|
$ cd GF
|
||||||
$ cabal install
|
$ cabal install
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -437,6 +412,27 @@ bindings are found in the ``src/runtime/python`` and ``src/runtime/java``
|
|||||||
directories, respecively. Compile them by following the instructions in
|
directories, respecively. Compile them by following the instructions in
|
||||||
the ``INSTALL`` files in those directories.
|
the ``INSTALL`` files in those directories.
|
||||||
|
|
||||||
|
== Compilation of RGL ==
|
||||||
|
|
||||||
|
As of 2018-07-26, the RGL is distributed separately from the GF compiler and runtimes.
|
||||||
|
|
||||||
|
=== Simple ===
|
||||||
|
To install the RGL, you can use the following commands from within the ``gf-rgl`` repository:
|
||||||
|
```
|
||||||
|
make install
|
||||||
|
```
|
||||||
|
There is also ``make build``, ``make copy`` and ``make clean`` which do what you might expect.
|
||||||
|
|
||||||
|
=== Advanced ===
|
||||||
|
```
|
||||||
|
runghc Make.hs ...
|
||||||
|
```
|
||||||
|
For more details see the [README https://github.com/GrammaticalFramework/gf-rgl/blob/master/README.md].
|
||||||
|
|
||||||
|
=== Haskell-free ===
|
||||||
|
```
|
||||||
|
./Make.sh
|
||||||
|
```
|
||||||
|
|
||||||
== Creating binary distribution packages ==
|
== Creating binary distribution packages ==
|
||||||
|
|
||||||
|
|||||||
@@ -143,22 +143,34 @@ The first time:
|
|||||||
%, assuming you already have the Haskell Platform and darcs
|
%, assuming you already have the Haskell Platform and darcs
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://github.com/GrammaticalFramework/GF.git
|
git clone https://github.com/GrammaticalFramework/gf-core.git
|
||||||
cd GF
|
cd gf-core
|
||||||
cabal install
|
cabal install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
and
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://github.com/GrammaticalFramework/gf-rgl.git
|
||||||
|
cd gf-rgl
|
||||||
|
make
|
||||||
|
```
|
||||||
|
|
||||||
Subsequently:
|
Subsequently:
|
||||||
|
|
||||||
```
|
```
|
||||||
cd GF
|
cd gf-core
|
||||||
git pull
|
git pull
|
||||||
cabal install
|
cabal install
|
||||||
```
|
```
|
||||||
|
|
||||||
%Alternatively, you can get the code from the
|
and
|
||||||
%[GF GitHub https://github.com/GrammaticalFramework/GF/] mirror, which is
|
|
||||||
%updated nightly.
|
```
|
||||||
|
cd gf-rgl
|
||||||
|
git pull
|
||||||
|
make
|
||||||
|
```
|
||||||
|
|
||||||
The above notes for installing from source apply also in these cases.
|
The above notes for installing from source apply also in these cases.
|
||||||
For more info on working with the GF source code, see the
|
For more info on working with the GF source code, see the
|
||||||
|
|||||||
4
gf.cabal
4
gf.cabal
@@ -9,7 +9,7 @@ category: Natural Language Processing, Compiler
|
|||||||
synopsis: Grammatical Framework
|
synopsis: Grammatical Framework
|
||||||
description: GF, Grammatical Framework, is a programming language for multilingual grammar applications
|
description: GF, Grammatical Framework, is a programming language for multilingual grammar applications
|
||||||
homepage: http://www.grammaticalframework.org/
|
homepage: http://www.grammaticalframework.org/
|
||||||
bug-reports: https://github.com/GrammaticalFramework/GF/issues
|
bug-reports: https://github.com/GrammaticalFramework/gf-core/issues
|
||||||
maintainer: Thomas Hallgren
|
maintainer: Thomas Hallgren
|
||||||
tested-with: GHC==7.6.3, GHC==7.8.3, GHC==7.10.3, GHC==8.0.2
|
tested-with: GHC==7.6.3, GHC==7.8.3, GHC==7.10.3, GHC==8.0.2
|
||||||
|
|
||||||
@@ -49,7 +49,7 @@ custom-setup
|
|||||||
|
|
||||||
source-repository head
|
source-repository head
|
||||||
type: git
|
type: git
|
||||||
location: https://github.com/GrammaticalFramework/GF.git
|
location: https://github.com/GrammaticalFramework/gf-core.git
|
||||||
|
|
||||||
flag interrupt
|
flag interrupt
|
||||||
Description: Enable Ctrl+Break in the shell
|
Description: Enable Ctrl+Break in the shell
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
<TITLE>GF - Grammatical Framework</TITLE>
|
<TITLE>GF - Grammatical Framework</TITLE>
|
||||||
<meta charset="UTF-8">
|
<meta charset="UTF-8">
|
||||||
<link rel="stylesheet" href="css/newstyle.css" title="GF">
|
<link rel="stylesheet" href="css/newstyle.css" title="GF">
|
||||||
<link rel="alternate" href="https://github.com/GrammaticalFramework/GF/" title="GF GitHub repository">
|
<link rel="alternate" href="https://github.com/GrammaticalFramework/gf-core/" title="GF GitHub repository">
|
||||||
<meta name = "viewport" content = "width = device-width">
|
<meta name = "viewport" content = "width = device-width">
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
function sitesearch() {
|
function sitesearch() {
|
||||||
@@ -41,7 +41,7 @@ function sitesearch() {
|
|||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><A HREF="http://groups.google.com/group/gf-dev">User Group</A>
|
<li><A HREF="http://groups.google.com/group/gf-dev">User Group</A>
|
||||||
<li><a href="https://github.com/GrammaticalFramework/GF/issues">Bug Reports</a>
|
<li><a href="https://github.com/GrammaticalFramework/gf-core/issues">Bug Reports</a>
|
||||||
(<a href="http://code.google.com/p/grammatical-framework/issues/list">old</a>)
|
(<a href="http://code.google.com/p/grammatical-framework/issues/list">old</a>)
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
@@ -71,7 +71,7 @@ function sitesearch() {
|
|||||||
<div class=links>
|
<div class=links>
|
||||||
<h4>Develop GF</h4>
|
<h4>Develop GF</h4>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="https://travis-ci.org/GrammaticalFramework/GF"><img src="https://travis-ci.org/GrammaticalFramework/GF.svg?branch=master" alt="GF build status"></a>
|
<li><a href="https://travis-ci.org/GrammaticalFramework/gf-core"><img src="https://travis-ci.org/GrammaticalFramework/gf-core.svg?branch=master" alt="GF build status"></a>
|
||||||
<li><a href="doc/gf-developers.html">GF Developers Guide</a>
|
<li><a href="doc/gf-developers.html">GF Developers Guide</a>
|
||||||
<li><A HREF="https://github.com/GrammaticalFramework/">GF on GitHub</A>
|
<li><A HREF="https://github.com/GrammaticalFramework/">GF on GitHub</A>
|
||||||
<li><a href="/~hallgren/gf-experiment/browse/">Browse Source Code</a>
|
<li><a href="/~hallgren/gf-experiment/browse/">Browse Source Code</a>
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ category: Natural Language Processing
|
|||||||
synopsis: Grammatical Framework
|
synopsis: Grammatical Framework
|
||||||
description: A library for interpreting the Portable Grammar Format (PGF)
|
description: A library for interpreting the Portable Grammar Format (PGF)
|
||||||
homepage: http://www.grammaticalframework.org/
|
homepage: http://www.grammaticalframework.org/
|
||||||
bug-reports: https://github.com/GrammaticalFramework/GF/issues
|
bug-reports: https://github.com/GrammaticalFramework/gf-core/issues
|
||||||
maintainer: Thomas Hallgren
|
maintainer: Thomas Hallgren
|
||||||
tested-with: GHC==7.6.3, GHC==7.8.3, GHC==7.10.3, GHC==8.0.2
|
tested-with: GHC==7.6.3, GHC==7.8.3, GHC==7.10.3, GHC==8.0.2
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user