From e3ff79d49c387507102892c76692588304bd2e4d Mon Sep 17 00:00:00 2001 From: hallgren Date: Tue, 22 Apr 2014 14:45:37 +0000 Subject: [PATCH] Some work on the download page and release notes for the next release of GF Please add things you think are imporant to mention to the release notes! --- download/index-next.t2t | 166 ++++++++++++++++++++++++++++++++++++++ download/release-next.t2t | 9 ++- 2 files changed, 171 insertions(+), 4 deletions(-) create mode 100644 download/index-next.t2t diff --git a/download/index-next.t2t b/download/index-next.t2t new file mode 100644 index 000000000..455d55c45 --- /dev/null +++ b/download/index-next.t2t @@ -0,0 +1,166 @@ +Grammatical Framework Download and Installation + + +%!style:../css/style.css +%!postproc(html): +%!postproc(html): <meta name = "viewport" content = "width = device-width"><TITLE> +%!postproc(html): <TD><B> <TH> +%!postproc(html): </B></TD> </TH> +%!postproc(html): <H1> <H1><a href="../"><IMG src="../doc/Logos/gf0.png"></a> + +**GF 3.6** has not been released yet. + +What's new? See the [Release notes release-3.6.html]. + + +== Binary packages == + +| **Platform** | **Download** | **How to install** +| Mac OS X | [gf-3.6-bin-intel-mac.tar.gz gf-3.6-bin-intel-mac.tar.gz] | ``sudo tar -C /usr/local -zxf gf-3.6-bin-intel-mac.tar.gz`` +%| Fedora (32-bit) | [Fedora RPMs /~hallgren/tmp/Fedora/] | ``sudo rpm -i ...`` +| Ubuntu (32-bit) | [gf_3.6-1_i386.deb gf_3.6-1_i386.deb] | ``sudo dpkg -i gf_3.6-1_i386.deb`` +| Ubuntu (64-bit) | [gf_3.6-1_amd64.deb gf_3.6-1_amd64.deb] | ``sudo dpkg -i gf_3.6-1_amd64.deb`` +| Windows | [gf-3.6-bin-windows.zip gf-3.6-bin-windows.zip] | ``unzip gf-3.6-bin-windows.zip`` +%| ... | ... | ... + +%More binary packages might be added later. + +===Notes=== + +The Windows package is installed by just unpacking it anywhere. +%It finds the libraries relative to the ``.exe`` file. +You will probably need to set the ``PATH`` and ``GF_LIB_PATH`` environment +variables, see Inari's notes on +[Installing GF on Windows http://www.grammaticalframework.org/~inari/gf-windows.html#toc3]. + +The ``.deb`` packages work on Ubuntu 12.04, 12.10 and 13.04. + +%The ``.pkg`` package works on MacOS X 10.6 (Snow Leopard). +The Mac OS tar package works on 10.8 (Mountain Lion) and 10.9 (Mavericks). + +The Mac OS and Linux ``.tar.gz`` packages are designed to be installed in +``/usr/local``. +You can install them in other locations, but then you need to set the +``GF_LIB_PATH`` environment variable: + +``` + export GF_LIB_PATH=/usr/local/share/gf-3.6/lib +``` + +where ``/usr/local`` should be replaced with the path to the location where you +unpacked the package. + + +==Installing the latest release from source== + +[GF is on Hackage http://hackage.haskell.org/package/gf], so the prodedure is +fairly simple: + ++ Install the [Haskell Platform http://hackage.haskell.org/platform] + version 2013.2.0.0 or 2012.4.0.0 (see notes 2&3 below) ++ ``cabal update`` ++ On Linux: install some C libraries from your Linux distribution + (see note 1 below) ++ ``cabal install gf`` + + +You can also download the full source package from here: +[``gf-3.6.tar.gz`` gf-3.6.tar.gz]. + +=== Notes === + +The above steps installs GF for a single user. +% and does not require root privileges. +The executables are put in ``$HOME/.cabal/bin`` +(or, with recent versions of the Haskell platform on Mac OS X, +in ``$HOME/Library/Haskell/bin``), so it is a good +idea to put a line in your ``.bash_profile`` to add that directory to you path: + +``` + PATH=$HOME/.cabal/bin:$PATH +``` +or +``` + PATH=$HOME/Library/Haskell/bin:$PATH +``` + +**Note 1**. +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. Here is one way to do this: + +- On Ubuntu: ``sudo apt-get install libghc-haskeline-dev`` +- On Fedora: ``sudo yum install ghc-haskeline-devel`` + + +**Note 2**. +We recommend using GHC 7.6 (which is part of the Haskell Platform 2013.2.0.0) +or GHC 7.4 (which is part of the Haskell Platform 2012.4.0.0). +Using GHC 7.0 will probably still work for the most part +(but there is an issue with error reporting in ``gf -server`` +when compiled with GHC 7.0.) +Compilation with GHC 6.12 is no longer supported, because of multiple package +version depenency problems. + +**Note 3**. +[The Haskell Platform for Mac OS X http://hackage.haskell.org/platform/mac.html] +page states that you need Xcode 3.2 or later, but in fact it appears you need +Xcode 3.2.3 or later. If you have Xcode 3.2.2, you can get an error from the +linker: ``ld: unknown option: -no_pie``. + +=== Known problems === + +There seems to be a bug in some versions of Cabal that can cause + +``` + Distribution/Simple/PackageIndex.hs:124:8-13: Assertion failed +``` + +if the same version of GF is +already installed. If you encounter this, you can use ``ghc-pkg unregister gf`` +to remove the installed version of GF and ``ghc-pkg list gf`` to verify that +it is gone. + +==Installing from the latest developer source code== + +The first time: +%, assuming you already have the Haskell Platform and darcs + +``` + darcs get --lazy http://www.grammaticalframework.org/ GF + cd GF + cabal install +``` + +Subsequently: + +``` + cd GF + darcs pull -a + cabal install +``` + +Alternatively, you can get the code from the +[GF GitHub https://github.com/GrammaticalFramework/GF/] mirror, which is +updated nightly. + +The above notes for installing from source apply also in these cases. +For more info on working with the GF source code, see the +[GF Developers Guide ../doc/gf-developers.html]. + +==Older releases== + +- [GF 3.5 index-3.5.html] (August 2013) +- [GF 3.4 index-3.4.html] (January 2013). +- [GF 3.3.3 index-3.3.3.html] (March 2012). +- [GF 3.3 index-3.3.html] (October 2011). +- [GF 3.2.9 index-3.2.9.html] source-only snapshot (September 2011). +- [GF 3.2 index-3.2.html] (December 2010). +- [GF 3.1.6 index-3.1.6.html] (April 2010). +- [GF 3.1 old-index.html] (December 2009). + + +-------------------- + +[www.grammaticalframework.org http://www.grammaticalframework.org] diff --git a/download/release-next.t2t b/download/release-next.t2t index 4dc66e9b5..a01e2e3b2 100644 --- a/download/release-next.t2t +++ b/download/release-next.t2t @@ -1,4 +1,4 @@ -GF x.y Release Notes +GF 3.6 Release Notes Not released yet %!style:../css/style.css @@ -14,7 +14,8 @@ See the [download page http://www.grammaticalframework.org/download/index.html]. Over [...] changes have been pushed to the source repository since the release of GF 3.5. -Closed issues: 25, 30, 41, 57, 60, 61, 68, 80, 81. +Closed [issues http://code.google.com/p/grammatical-framework/issues/list]: + 25, 30, 41, 57, 60, 61, 68, 80, 81, 82. ===GF compiler and run-time library=== @@ -33,7 +34,7 @@ Closed issues: 25, 30, 41, 57, 60, 61, 68, 80, 81. - Nonlinear patterns (i.e., patterns where the same variable appears more than once) in concrete syntax are now detected and reported as errors. - (Section C.4.13 in the GF book explicitly states that patterns must be + (Section C.4.13 in the GF book states that patterns must be linear.) - A pattern matching bug which prevented variables in patterns to be bound to table values has been fixed. @@ -42,7 +43,7 @@ Closed issues: 25, 30, 41, 57, 60, 61, 68, 80, 81. % (and thus the command line option --dump-refresh) had become obsolete and has been removed. - The old partial evaluator - (and thus the command line options --new-comp and --old-comp) + (and thus the command line options ``--new-comp`` and ``--old-comp``) has been removed.