README.txt

``peng3d`` - Python and pyglet based 3D Engine and toolkit
==========================================================

.. image:: https://readthedocs.org/projects/peng3d/badge/?version=latest
   :target: http://peng3d.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. image:: https://img.shields.io/pypi/dm/peng3d
   :alt: PyPI - Downloads

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black

.. image:: https://circleci.com/gh/not-na/peng3d.svg?style=svg
    :target: https://circleci.com/gh/not-na/peng3d

peng3d is an open-source 3D graphics engine written in python and with pyglet.

peng3d aims to make creating quick-and-easy visualizations and proof-of-concept projects easier
while still being powerful enough for larger projects as well.

peng3d is a set of tools and classes extending built-in pyglet and python functionality with easier to use variants that are still compatible with low-level programming and old code.

You can install peng3d by cloning this project and executing ``python setup.py install``.

See here for Linux::
   
   $ git clone https://github.com/not-na/peng3d.git
   
   $ cd peng3d
   
   $ python setup.py install

This package can also be installed via pip:
   
   $ pip install peng3d

See the docs linked under the badge above for more information, including API documentation and some guides!