Minimal update with new repo URLs & build instructions

This commit is contained in:
John J. Camilleri
2018-07-26 01:37:03 +02:00
parent 59e66adb35
commit 636a8142b4
6 changed files with 59 additions and 51 deletions

View File

@@ -2,7 +2,7 @@
# Grammatical Framework (GF)
[![Build Status](https://travis-ci.org/GrammaticalFramework/GF.svg?branch=master)](https://travis-ci.org/GrammaticalFramework/GF)
[![Build Status](https://travis-ci.org/GrammaticalFramework/gf-core.svg?branch=master)](https://travis-ci.org/GrammaticalFramework/gf-core)
The Grammatical Framework is a grammar formalism based on type theory.
It consists of:

View File

@@ -57,7 +57,7 @@ of the Haskell Platform was successful you should see a message like:
The Glorious Glasgow Haskell Compilation System, version 8.0.2
```
Other required tools included in the Haskell Platform are
Other required tools included in the Haskell Platform are
[Cabal http://www.haskell.org/cabal/],
[Alex http://www.haskell.org/alex/]
and
@@ -105,24 +105,23 @@ GF then you should consider getting read-write 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
directory.
This will create directories ``gf-core`` and ``gf-rgl`` in the current directory.
==== Updating your copy ====
To get all new patches from the main repo:
To get all new patches from each repo:
```
$ git pull
```
This can be done anywhere in your local repository, i.e. in the ``gf``
directory, or any of its subdirectories.
This can be done anywhere in your local repository.
==== Recording local changes ====[record]
@@ -130,7 +129,7 @@ directory, or any of its subdirectories.
Since every copy is a repository, you can have local version control
of your changes.
If you have added files, you first need to tell your local repository to
If you have added files, you first need to tell your local repository to
keep them under revision control:
```
@@ -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.
%==== 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 ===
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
```
$ cd gf
$ cd GF
$ 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
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 ==
@@ -519,7 +515,7 @@ $ cabal test
```
The testsuite architecture for GF is very simple but still very flexible.
GF by itself is an interpreter and could execute commands in batch mode.
This is everything that we need to organize a testsuite. The root of the
This is everything that we need to organize a testsuite. The root of the
testsuite is the testsuite/ directory. It contains subdirectories which
themself contain GF batch files (with extension .gfs). The above command
searches the subdirectories of the testsuite/ directory for files with extension

View File

@@ -55,7 +55,7 @@ Linux distributions.
The packages for macOS (Mac OS X) should work on at
least 10.11 and 10.12 (El Capitan and Sierra).
%(*) **Note** that for compatibility with OS X 10.11 and newer,
%(*) **Note** that for compatibility with OS X 10.11 and newer,
%``gf-3.9.pkg`` will install the ``gf`` executable in ``/usr/local/bin``
%instead of ``/usr/bin``, so make sure ``/usr/local/bin`` is in your ``$PATH``.
%Also, if you still have an older version of GF installed in ``/usr/bin``,
@@ -143,22 +143,34 @@ The first time:
%, assuming you already have the Haskell Platform and darcs
```
git clone https://github.com/GrammaticalFramework/GF.git
cd GF
git clone https://github.com/GrammaticalFramework/gf-core.git
cd gf-core
cabal install
```
and
```
git clone https://github.com/GrammaticalFramework/gf-rgl.git
cd gf-rgl
make
```
Subsequently:
```
cd GF
cd gf-core
git pull
cabal install
```
%Alternatively, you can get the code from the
%[GF GitHub https://github.com/GrammaticalFramework/GF/] mirror, which is
%updated nightly.
and
```
cd gf-rgl
git pull
make
```
The above notes for installing from source apply also in these cases.
For more info on working with the GF source code, see the

View File

@@ -9,7 +9,7 @@ category: Natural Language Processing, Compiler
synopsis: Grammatical Framework
description: GF, Grammatical Framework, is a programming language for multilingual grammar applications
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
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
type: git
location: https://github.com/GrammaticalFramework/GF.git
location: https://github.com/GrammaticalFramework/gf-core.git
flag interrupt
Description: Enable Ctrl+Break in the shell

View File

@@ -4,7 +4,7 @@
<TITLE>GF - Grammatical Framework</TITLE>
<meta charset="UTF-8">
<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">
<script type="text/javascript">
function sitesearch() {
@@ -41,7 +41,7 @@ function sitesearch() {
<ul>
<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>)
</ul>
</div>
@@ -71,7 +71,7 @@ function sitesearch() {
<div class=links>
<h4>Develop GF</h4>
<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="https://github.com/GrammaticalFramework/">GF on GitHub</A>
<li><a href="/~hallgren/gf-experiment/browse/">Browse Source Code</a>

View File

@@ -8,7 +8,7 @@ category: Natural Language Processing
synopsis: Grammatical Framework
description: A library for interpreting the Portable Grammar Format (PGF)
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
tested-with: GHC==7.6.3, GHC==7.8.3, GHC==7.10.3, GHC==8.0.2
@@ -45,9 +45,9 @@ Library
--if impl(ghc>=7.8)
-- ghc-options: +RTS -A20M -RTS
ghc-prof-options: -fprof-auto
extensions:
extensions:
exposed-modules:
exposed-modules:
PGF
PGF.Internal
PGF.Haskell