Skip to content

Commit

Permalink
Rename
Browse files Browse the repository at this point in the history
  • Loading branch information
matsjoyce committed Jan 25, 2017
1 parent 7bfe8fc commit 0be53a5
Show file tree
Hide file tree
Showing 24 changed files with 186 additions and 170 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
pygame-quick
============
pygame-go
=========

A simplified version of PyGame for use in teaching.
A pythonic wrapper around PyGame, drastically reducing the complexity of 99% of PyGame programs. Especially useful for teaching.

[![Documentation Status](https://readthedocs.org/projects/pygame-quick/badge/?version=latest)](http://pygame-quick.readthedocs.io/en/latest/?badge=latest)
[![Documentation Status](https://readthedocs.org/projects/pygame-go/badge/?version=latest)](http://pygame-go.readthedocs.io/en/latest/?badge=latest)

Example
-------

Bounce a red ball around the screen:

```python
import pygame_quick as pgq
import pygame_go as pygo

BALL_RADIUS = 50

window = pgq.window(800, 600, frame_rate=60)
window = pygo.window(800, 600, frame_rate=60)

ball_x, ball_y = window.center
ball_dx = ball_dy = 5
Expand Down Expand Up @@ -93,7 +93,7 @@ while active:
Documentation
-------------

Go to https://pygame-quick.readthedocs.io.
Go to https://pygame-go.readthedocs.io.

Requirements
------------
Expand All @@ -114,7 +114,7 @@ Installation
------------

```bash
git clone https://github.com/matsjoyce/pygame-quick.git
cd pygame-quick
git clone https://github.com/matsjoyce/pygame-go.git
cd pygame-go
python3 setup.py install
```
4 changes: 2 additions & 2 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = pygame-quick
SPHINXPROJ = pygame-go
SOURCEDIR = .
BUILDDIR = _build

Expand All @@ -17,4 +17,4 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
26 changes: 14 additions & 12 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# pygame-quick documentation build configuration file, created by
# pygame-go documentation build configuration file, created by
# sphinx-quickstart on Thu Jan 19 09:51:09 2017.
#
# This file is execfile()d with the current directory set to its
Expand All @@ -22,6 +22,7 @@

# Provide blank pygame as we don't need it installed to read the metadata


class FakeModule:
colors = {}

Expand All @@ -39,8 +40,9 @@ def __iter__(self):
sys.modules["pygame"] = FakeModule()
sys.path.insert(0, os.path.abspath('..'))


import sphinx_rtd_theme
import pygame_quick
import pygame_go as pygo


# -- General configuration ------------------------------------------------
Expand Down Expand Up @@ -68,18 +70,18 @@ def __iter__(self):
master_doc = 'index'

# General information about the project.
project = 'pygame-quick'
copyright = pygame_quick.__copyright__
author = pygame_quick.__author__
project = 'pygame-go'
copyright = pygo.__copyright__
author = pygo.__author__

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = ".".join(pygame_quick.__version__.split(".")[:2])
version = ".".join(pygo.__version__.split(".")[:2])
# The full version, including alpha/beta/rc tags.
release = pygame_quick.__version__
release = pygo.__version__

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -125,7 +127,7 @@ def __iter__(self):
# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'pygame-quickdoc'
htmlhelp_basename = 'pygame-godoc'


# -- Options for LaTeX output ---------------------------------------------
Expand All @@ -152,7 +154,7 @@ def __iter__(self):
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'pygame-quick.tex', 'pygame-quick Documentation',
(master_doc, 'pygame-go.tex', 'pygame-go Documentation',
'Matthew Joyce', 'manual'),
]

Expand All @@ -162,7 +164,7 @@ def __iter__(self):
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'pygame-quick', 'pygame-quick Documentation',
(master_doc, 'pygame-go', 'pygame-go Documentation',
[author], 1)
]

Expand All @@ -173,7 +175,7 @@ def __iter__(self):
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'pygame-quick', 'pygame-quick Documentation',
author, 'pygame-quick', 'One line description of project.',
(master_doc, 'pygame-go', 'pygame-go Documentation',
author, 'pygame-go', 'PyGame for Humans!',
'Miscellaneous'),
]
4 changes: 2 additions & 2 deletions docs/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ Classes

Bases: :class:`image`

.. method:: __init__(<size>, *, [<color="white">, frame_rate=20, autoquit=True, title="pygame-quick", icon=None])
.. method:: __init__(<size>, *, [<color="white">, frame_rate=20, autoquit=True, title="pygame-go", icon=None])

Create the window with the size ``<size>``. If ``<color>`` is given, the window will be filled with that color, otherwise it is filled with white. ``frame_rate`` is the number of updates per second, which is controlled during the :func:`update` method call. If ``autoquit`` is ``True``, then quit events will be processed automatically and :func:`active` will return ``False`` without any event processing by the user. If ``autoquit`` is ``False``, the quit events will be accessible though :func:`events`. ``title`` will be used to set the window title, see :attr:`title`. ``icon`` will be used to set the window icon, see :attr:`icon`.

Expand Down Expand Up @@ -584,7 +584,7 @@ Classes

Type: :class:`str`

The key that was pressed. It can either be a single ASCII character or a modifier / non-printable key like ``<Shift>`` or ``<Ctrl>``. See ``pygame_quick/events.py`` for the full listing.
The key that was pressed. It can either be a single ASCII character or a modifier / non-printable key like ``<Shift>`` or ``<Ctrl>``. See ``pygame_go/events.py`` for the full listing.

.. class:: QuitEvent

Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Welcome to pygame-quick's documentation!
========================================
Welcome to pygame-go's documentation!
=====================================

.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit 0be53a5

Please sign in to comment.