GitHub/gf-core
1
0
Fork 1
mirror of https://github.com/GrammaticalFramework/gf-core.git synced 2026-04-18 09:19:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

update the developers documentation with instructions for building and running the testsuite

Browse Source
This commit is contained in:
krasimir
2009-06-13 18:02:06 +00:00
parent 4e119eb63c
commit 3dc7289835
8 changed files with 805 additions and 533 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
src/INSTALL
View File

@@ -1,81 +0,0 @@
To make and install GF (Updated for version 2.4 and 3.0beta).
1. Unpack GF and go to the source directory (the place where this
INSTALL file is - so you have probably done this already!)
tar xvfz GF-2.4.tgz
cd GF-2.4/src
3. Make sure you have GHC (Glasgow Haskell Compiler), preferably version 6.8.
NOTICE: GHC 6.10 does not work with GF source yet.
ghc --version
4. If you are building the darcs version, run autoconf (in src/):
autoconf
5. Run configure
./configure
If you want to install the GF somewhere other than /usr/local, use
the --prefix flag. E.g.
./configure --prefix=/usr
If you experience problems with readline, try:
./configure --with-readline=no
You may need to run "make clean" after ./configure when you change the
readline setting.
6. Compile with GNU make:
make
or
gmake
(if your system has a proprietary make)
The binary is sent to the file GF/bin/gf .
7. Move files to their right places:
make install
8. To run GF, the following environment variables must be set:
GFHOME the GF directory, e.g., "$HOME/project/GF-2.4"
GF_LIB_PATH the GF library directory, e.g,, "$HOME/project/GF-2.4/lib"
(Usually, you do this in ~/.login, if your shell is any *csh,
or in ~/.profile, if your shell is either of sh, ksh, zsh or bash.
Afterwards, you have to start a login shell to have the settings available.)
9. For a quick test:
Start gf, load a grammar and parse a string:
cd $GFHOME/examples/tutorial/food
gf FoodIta.gf FoodEng.gf
-- when gf has started and shows the prompt >:
> parse "this cheese is very very Italian" | linearize -treebank
-- this is the response from GF:
Is (This Cheese) (Very (Very Italian))
this cheese is very very Italian
questo formaggio è molto molto italiano
> generate_random | linearize -treebank
> help
Author: Aarne Ranta, Björn Bringert 8/11/2004 -- 26/01/2006 -- 27/6/2008

38
src/INSTALL.binary
View File

@@ -1,38 +0,0 @@
Installing a binary GF distribution:
1. Untar the distribution file:
$ gtar -zxf GF-2.8-[host].tar.gz
2. Go to the created directory:
$ cd GF-2.8-[host]
3. Run configure:
$ ./configure
If you don't want to install the files under /usr/local,
run configure with the right installation prefix. E.g.:
$ ./configure --prefix=/usr
4. Install:
$ make install
If the above procedure should fail (e.g. you don't have "make" available), you
can do a manual install:
1. Untar the package and go to the GF directory, as 1-2 above.
2. The executable is the file "gf". You may want to move it somewhere
else, e.g. /usr/local/bin
3. The libraries are in the subdirectory "lib/". It is recommended to
create an environment variable GF_LIB_PATH pointing to that directory.
In the bash shell, you do
$ export GF_LIB_PATH=[your gf directory]/lib