yamgl-gen 0.0.4

Data structure generator for the yamgl library (Yet Another Monochrome Graphics Library).

Author:

Ionut-Catalin Pavel

Contents

• 1 Introduction

  • 1.1 What is yamgl_gen?

  • 1.2 How is yamgl_gen licensed?

  • 1.3 Contact details

• 2 Installing

  • 2.1 Prerequisites

  • 2.2 Installation process

• 3 Using

  • 3.1 Usage rationale

  • 3.2 Usage scenario

• 4 Package contents

1 Introduction

1.1 What is yamgl_gen?

yamgl_gen is a generator used for producing compile time object data for the yamgl library.

1.2 How is yamgl_gen licensed?

BSD license.

1.3 Contact details

For reporting problems with yamgl_gen or submitting feature requests, please open an issue, or submit a pull request.

2 Installing

2.1 Prerequisites

• yamgl_gen was tested on Python 3.6, on Windows. Compatibility with older version is not guaranteed.

• yamgl_gen has the following dependencies:

• lxml

• freetype

• Pillow

2.2 Installation process

Installing yamgl_gen is very simple. Once you download and unzip the package, you just have to execute the standard python setup.py install. The setup script will then place the yamgl_gen module into site-packages in your Python’s installation library.

Alternatively, since yamgl_gen is listed in the Python Package Index (PyPI), you can install it using your favorite Python packaging/distribution tool, for example with:

> pip install yamgl_gen

3 Using

3.1 Usage rationale

yamgl_gen parses a given xlm file that must comply with the following schema , the xml file contains all the objects that generate data.

3.2 Usage scenario

A sample xml file is given inside the examples folder. The file contains generation instructions for some fonts and a image. The fonts and the image are not part of this release due to legal reasons.

The application will generate a pair of source files (a source and a header). The command line syntax is better detailed by running:

> python yamgl_gen --help

4 Package contents

Once you unzip the yamgl_gen package, you’ll see the following files and directories:

README.rst:

This README file.

LICENSE:

The yamgl_gen license

setup.py:

Installation script

examples/:

A directory with some examples of using yamgl_gen

yamgl_gen/:

The yamgl_gen module source code.

tests/:

Unit tests.