Skip to content

python-sge/sge

Repository files navigation

This file has been dedicated to the public domain, to the extent
possible under applicable law, via CC0. See
https://creativecommons.org/publicdomain/zero/1.0/ for more
information. This file is offered as-is, without any warranty.

========================================================================

LICENSE

The Pygame SGE is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

The Pygame SGE is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with the Pygame SGE.  If not, see <https://www.gnu.org/licenses/>.


INSTALLATION

First, install the dependencies:

- Python 3.6 or later <https://www.python.org>
- Pygame 2.0 or later <https://pygame.org>
- uniseg <https://pypi.python.org/pypi/uniseg>

Once you have all the dependencies, install the SGE with the included
setup.py script, e.g. with "python setup.py install".

Alternatively, you can just place the "sge" folder into the same
directory as the Python program that uses it. This can be a good idea
for the distribution of a game, since it reduces the number of
dependencies the user needs to install.


USAGE

See the "doc" folder for detailed documentation on how to use the SGE.


PYGAME SGE IMPLEMENTATION DETAILS

See README.pygame for information specific to the Pygame SGE.