Grammatical Framework Minibar

This is the UCT Computer Science capstone project for the team ACRONYM.

Table of Contents

• Introduction
• New Features
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• License
• Repository

Introduction

Grammatical Framework (GF) is a programming language for writing grammars of natural languages. GF is capable of parsing and generating texts in several languages simultaneously while working from a language-independent representation of meaning.

This Grammatical Framework Minibar (GFM) is an alternative implementation of the GF web app Minibar Online. GFM is a useful tool for developers working with the Grammatical Framework. GFM provides a graphical user interface to interact with and test Grammatical Framewok programs.

New Features

These are some of the new features implemented in this version of GFM

• Offline access
• Swappable grammars (Use of custom/local grammars)
• Predictive typing
• Translation of multiple sentences
• Easy/intuitive word deletion

Getting Started

These are the steps to get started working with the application locally on your computer. Only Linux and Windows computers supported (for now).

Prerequisites

• Java Runtime Environment (JRE 8) and Java Development Kit (JDK 17 or JDK 20)
• Make (Can be downloaded here)

Installation

1. Download the source code (zip, tar, tar.gz) and extract all to the required directory
2. Navigate to the appropriate directory for your operating system
3. Run the application: For Windows - double click run.bat; For Linux - right click run.sh and run as program

Contributing

1. Fork the repository.
2. Create a new branch: git checkout -b feature-name.
3. Make your changes and commit them: git commit -m 'Add some feature'.
4. Push to the branch: git push origin feature-name.
5. Create a pull request.

License

BSD LICENSE - Copyright (c) 1998, Grammatical Framework. All rights reserved.
Credit to Thomas Hallgren, the creator of the first GFM.

Repository

Find the gitlab repository here