Commit 1ec95f16 authored by POGODALLA Sylvain's avatar POGODALLA Sylvain

Update of the README/INSTALL files to remove mention of .opt binaries and give...

Update of the README/INSTALL files to remove mention of .opt binaries and give updated info about opam
parent 4453ebfc
......@@ -59,7 +59,7 @@ This will install in the `.opam/OCAML_VERSION/bin` directory (where
`OCAML_VERSION` is the OCaml version that you are using with opam. It
can be `system` in case you are not using a compiler installed by
opam, or a version number (such as 4.05.0) otherwise) the binaries
`acgc`, `acgc.opt`, `acg`, and `acg.opt`.
`acgc` and `acg`.
It will also install in the `.opam/OCAML_VERSION/share/acgtk` directory:
......
......@@ -2,7 +2,7 @@
# INSTALL
**ACGtk** is a software package ([2008-2018 INRIA](http://www.inria.fr)©) for the development of abstract categorial grammars. This distribution provides two executables (possibly with the `.opt` extension, see the (INSTALL)[INSTALL] file: `acgc` and `acg` (or, instead, their native counterparts: `acgc.opt` and `acg.opt`).
**ACGtk** is a software package ([2008-2018 INRIA](http://www.inria.fr)©) for the development of abstract categorial grammars. This distribution provides two executables file: `acgc` and `acg`.
It is distributed with the *CeCILL* license (see the [LICENSE](LICENSE.en) file or http://www.cecill.info). Contributors are listed in the (AUTHORS)[AUTHORS] file.
......@@ -50,13 +50,15 @@ The installation typically goes that way:
4. then continue with the ACG toolkit installation running `opam install acgtk`
This will install in the `.opam/OCAML_VERSION/bin` directory (where `OCAML_VERSION` is the OCaml version that you are using with opam. It can be `system` in case you are not using a compiler installed by opam, or a version number (such as 4.05.0) otherwise) the binaries `acgc`, `acgc.opt`, `acg`, and `acg.opt`.
This will install in the `.opam/OCAML_VERSION/bin` directory (where `OCAML_VERSION` is the OCaml version that you are using with opam. It can be `system` in case you are not using a compiler installed by opam, or a version number (such as 4.05.0) otherwise) the binaries `acgc` and `acg`.
It will also install in the `.opam/OCAML_VERSION/share/acgtk` directory:
1. the [emacs](emacs) directory
1. the [emacs](emacs) directory
2. the [examples](examples) directory
(To get the actual path of the `share` directory, just run `opam var share`.)
### Building ACGtk (Skip this part if you installed acgtk as described above)
Alternatively, if you want to compile acgtk by yourself
......@@ -86,7 +88,7 @@ Copy the following lines in your .emacs
where `EMACS_DIR_PATH` is `.opam/OCAML_VERSION/share/acgtk/emacs`
### Site distribution
1. Copy `acg.el` under an `acg` directory in your site-lisp directory (typically `/usr/share/emacs/site-lisp/` or `/usr/local/share/emacs/site-lisp/`)
2. Create a `50acg.el` file into the `/etc/emacs/site-start.d` directory and copy the following lines in it:
......
......@@ -17,8 +17,7 @@
* *
**************************************************************************
This distribution provides two executables (possibly with the .opt
extension, see the INSTALL file):
This distribution provides two executables:
acgc
and
......@@ -113,7 +112,7 @@ Type CTRL-D to exit from the program, or type:
* SVG output *
**************
If the -nsvg option is not set when running acg.opt/acg, a file
If the -nsvg option is not set when running acg, a file
"realize.svg" (default name) is generated in the current directory
whenever a 'realize' command is invoked. In order to set another file
name, use the option -svg other_filename.
......@@ -197,8 +196,7 @@ searching.
1. First load an acg file
2. then run "M-x compile" (or C-cC-c) to call the compiler (acgc or
acgc.opt)
2. then run "M-x compile" (or C-cC-c) to call the compiler (acgc)
3. then run "M-x next-error" (or C-x`) to search for the next error
(if any) and highlights it
......
# ACGtk: an ACG development toolkit
**ACGtk** is a software package ([2008-2017 INRIA](http://www.inria.fr)©) for the development of abstract categorial grammars. This distribution provides two executables (possibly with the `.opt` extension, see the [INSTALL.md](INSTALL.md) file: `acgc` and `acg` (or, instead, their native counterparts: `acgc.opt` and `acg.opt`).
**ACGtk** is a software package ([2008-2017 INRIA](http://www.inria.fr)©) for the development of abstract categorial grammars. This distribution provides two executables file: `acgc` and `acg`.
It is distributed with the *CeCILL* license (see the [LICENSE](LICENSE.en) file or http://www.cecill.info). Contributors are listed in the [AUTHORS.md](AUTHORS.md) file.
......@@ -11,7 +11,7 @@ A list of related publications is available at the [ACG web page](http://calligr
`acgc` is a "compiler" of ACG source code, i.e. files containing definitions of signatures and lexicons. It basically checks whether they are correctly written (syntactically and wrt types and constant typing) and outputs a `.acgo` object file. An interactive mode is available to parse terms according to signatures.
Run
Run
```bash
./acgc -help
```
......@@ -71,7 +71,7 @@ Type `CTRL-D` to exit from the program, or type:
### SVG output
If the `-nsvg` option is not set when running `acg.opt` or `acg`, a file `realize.svg` (default name) is generated in the current directory whenever a `realize` command is invoked. In order to set another file name, use the option `-svg other_filename`.
If the `-nsvg` option is not set when running `acg, a file `realize.svg` (default name) is generated in the current directory whenever a `realize` command is invoked. In order to set another file name, use the option `-svg other_filename`.
This files contains a representation as a tree of the operations described by the term to realize (applications, abstractions). Each
node contains the abstract term and its realizations by each of the lexicons specified on the command line. The graphic file can for
......@@ -125,7 +125,7 @@ $ cat config.json
```
An example file is given in [examples/config.json](examples/config.json)
## ACG emacs mode
## ACG emacs mode
There is an ACG emacs mode `acg.el` in the [emacs](emacs) directory.
......@@ -135,7 +135,7 @@ It's main feature is to be loaded when editing an acg data file (with signatures
It basically contains compilation directives and next-error searching.
1. First load an acg file
2. then run `M-x compile` (or `C-c C-c`) to call the compiler (`acgc` or `acgc.opt`)
2. then run `M-x compile` (or `C-c C-c`) to call the compiler (`acgc`)
3. then run `M-x next-error` (or ``C-x` `) to search for the next error (if any) and highlights it
## Syntax of signature and lexicons
......@@ -210,7 +210,7 @@ end
+ an (optional) precedence declaration (if not present, the highest precedence over all the infix operators defined so far is given). It is defined as `< SYM` (where `SYM` is a symbol). It assigns to the operator being declared or defined the greates precedence *below* the precedence of `SYM`.
It is possible to use an infix symbol as a normal constant by surrounding it with left and right parenthesis, so that `t SYM u = (SYM) t u`
See [examples/infix-examples](examples/infix-examples) and [examples/infix-examples-script](examples/infix-examples) for examples.
### Lexicons
......@@ -242,10 +242,9 @@ There are two ways to define a lexicon:
## Keywords
The keywords are "signature, "lexicon, "nl_lexicon", "end", "type", "prefix", "infix", "binder", "lambda", and "Lambda".
The reserved symbols are '=', '<<', ';', ':', ',', '('), ')', '.', '->', '=>', and ':='.
Inside a signature or a lexicon, "signature", "lexicon" and "nl_lexicon" are not considered as keywords and can be used as identifier.
Other keywords can be used as identifier when escaped with '\' (e.g., "\end").
Other keywords can be used as identifier when escaped with '\' (e.g., "\end").
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment