Skip to content

Commit

Permalink
More README-files in markdown syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
tkuhn committed Jan 5, 2012
1 parent 12f6e98 commit 3e0d1df
Show file tree
Hide file tree
Showing 5 changed files with 79 additions and 89 deletions.
9 changes: 9 additions & 0 deletions README.md
Expand Up @@ -271,3 +271,12 @@ Apart from these main packages, there are some additional folders:
- `tools/` contains some auxiliary scripts

For more information consult the commented source files.


Mailing List
------------

If you encounter problems, you can get help from the Attempto community. Visit the Attempto Mailing
List site:

http://attempto.ifi.uzh.ch/site/mailinglist/
19 changes: 19 additions & 0 deletions examples/README.md
@@ -0,0 +1,19 @@
Examples
========

Introduction
------------

Some examples of using ACE->DRS, DRS->ACE, and ACE->OWL programmatically.


Usage
-----

Examples of calling the scripts from the command line:

$ swipl -s ace_to_ace.pl -g "t('Every man is a human.')" -t halt

$ swipl -s ace_to_owl.pl -g "t('Every man is a human.')" -t halt

$ swipl -s paraphrase_roundtrip.pl -g paraphrase_roundtrip -t halt
17 changes: 0 additions & 17 deletions examples/README.txt

This file was deleted.

51 changes: 51 additions & 0 deletions java/README.md
@@ -0,0 +1,51 @@
Java Interface for APE
======================

Copyright 2008-2012, Attempto Group, University of Zurich (http://attempto.ifi.uzh.ch).

The Java Interface for APE is part of the Attempto Parsing Engine
(https://github.com/Attempto/APE).

The Java Interface for APE is free software licensed under the GNU Lesser General Public
Licence (see LICENSE.txt and http://www.gnu.org/licenses/lgpl.html).

See java/lib/README.txt for information about the used third-party libraries.


Content
-------

The Java Interface for APE consists of one jar-file `attempto-ape.jar`, which contains interfaces
to the Attempto Parsing Engine (APE).

See docs/index.html for the detailed documentation of the packages and classes (you might have to
run the respective Ant command first, see below).


Compilation
-----------

Apache Ant is needed for compilation. The following commands are available:

- `ant compile` compiles the Java source code.
- `ant createjars` creates the jar-files.
- `ant createjavadoc` creates the Javadoc documentation pages.
- `ant clean` deletes all automatically generated files like the compiled Java classes, the
jar-files, and the Javadoc files.
- `ant buildeverything` builds everything from scratch.


APELocal
--------

The APELocal class is an interface to the ACE parser that is written in SWI Prolog. When this class
is used directly or indirectly, you have to make sure that a recent version of SWI Prolog is
installed and that the file ape.exe is available.

Furthermore, you have to use the following Java VM argument that points to the location where the
SWI Prolog system file libjpl.jnilib (under Mac OS X), jpl.dll (under Windows), or libjpl.so (under
Unix) is located:

-Djava.library.path="/opt/local/lib/swipl-5.6.45/lib/i386-darwin8.10.1"

Note that the exact path is most probably different on your system.
72 changes: 0 additions & 72 deletions java/README.txt

This file was deleted.

0 comments on commit 3e0d1df

Please sign in to comment.