summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..7e04ce573
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+![GF Logo](doc/Logos/gf1.svg)
+
+# Grammatical Framework (GF)
+
+[![Build Status](https://travis-ci.org/GrammaticalFramework/GF.svg?branch=master)](https://travis-ci.org/GrammaticalFramework/GF)
+
+The Grammatical Framework is a grammar formalism based on type theory.
+It consists of:
+
+- a special-purpose programming language
+- a compiler of the language
+- a generic grammar processor
+
+The compiler reads GF grammars from user-provided files, and the
+generic grammar processor performs various tasks with the grammars:
+
+- generation
+- parsing
+- translation
+- type checking
+- computation
+- paraphrasing
+- random generation
+- syntax editing
+
+GF particularly addresses four aspects of grammars:
+
+- multilinguality (parallel grammars for different languages)
+- semantics (semantic conditions of well-formedness, semantic properties of expressions)
+- grammar engineering (modularity, abstractions, libraries)
+- embeddability in programs written in other languages (C, C++, Haskell, Java, JavaScript)
+
+COMPILATION and INSTALLATION of source distribution:
+See [download/index.html](download/index.html) for installation instructions.
+More details can be found in [doc/gf-developers.html](doc/gf-developers.html).