Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
Capitalized some proper names, e.g. "Pygame," "Python," and "GitHub" for consistency
  • Loading branch information
Thunderborne committed Nov 2, 2023
1 parent 3612117 commit 467db56
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ It uses the `Simple DirectMedia Layer library`_ and several other
popular libraries to abstract the most common functions, making writing
these programs a more intuitive task.

`We need your help`_ to make pygame the best it can be!
`We need your help`_ to make Pygame the best it can be!
New contributors are welcome.


Installation
------------

Before installing pygame, you must check that Python is installed
Before installing Pygame, you must check that Python is installed
on your machine. To find out, open a command prompt (if you have
Windows) or a terminal (if you have MacOS or Linux) and type this:
::
Expand All @@ -42,7 +42,7 @@ command:


If a message such as "pip 20.0.2 from /usr/lib/python3/dist-packages/pip
(python 3.8)" appears, you are ready to install pygame! To install
(python 3.8)" appears, you are ready to install Pygame! To install
it, enter this command:
::

Expand All @@ -52,7 +52,7 @@ it, enter this command:
Help
----

If you are just getting started with pygame, you should be able to
If you are just getting started with Pygame, you should be able to
get started fairly quickly. Pygame comes with many tutorials and
introductions. There is also full reference documentation for the
entire library. Browse the documentation on the `docs page`_. You
Expand All @@ -61,7 +61,7 @@ can also browse the documentation locally by running
locally, it'll launch the online website instead.

The online documentation stays up to date with the development version
of pygame on github. This may be a bit newer than the version of pygame
of Pygame on GitHub. This may be a bit newer than the version of Pygame
you are using. To upgrade to the latest full release, run
``pip install pygame --upgrade`` in your terminal.

Expand Down Expand Up @@ -98,13 +98,13 @@ Building From Source
--------------------

If you want to use features that are currently in development,
or you want to contribute to pygame, you will need to build pygame
or you want to contribute to Pygame, you will need to build Pygame
locally from its source code, rather than pip installing it.

Installing from source is fairly automated. The most work will
involve compiling and installing all the pygame dependencies. Once
involve compiling and installing all the Pygame dependencies. Once
that is done, run the ``setup.py`` script which will attempt to
auto-configure, build, and install pygame.
auto-configure, build, and install Pygame.

Much more information about installing and compiling is available
on the `Compilation wiki page`_.
Expand All @@ -116,9 +116,9 @@ Contribute
| To contribute to the main `project documentation <https://www.pygame.org/docs/>`_, see ``docs/README.md`` or view more detailed instructions `here <https://github.com/pygame/pygame/tree/main/docs>`_.
|
| New to contributing to Open Source Free Libre software?
| There is a draft of `"Let's write a unit test!" <http://renesd.blogspot.com/2019/11/draft-2-of-lets-write-unit-test.html>`_ which is a step by step guide on how to write your first unit test in python for pygame, which is very similar to how you would do it for other projects.
| There is a draft of `"Let's write a unit test!" <http://renesd.blogspot.com/2019/11/draft-2-of-lets-write-unit-test.html>`_ which is a step by step guide on how to write your first unit test in Python for Pygame, which is very similar to how you would do it for other projects.
|
| Want or need to compile pygame from source?
| Want or need to compile Pygame from source?
| `See the compilation page <https://www.pygame.org/wiki/Compilation>`_ for more detailed instructions.
|
| For a detailed developer guide on "How to Hack Pygame":
Expand Down Expand Up @@ -182,7 +182,7 @@ pygame.org wiki.
Also many thanks for people creating games and putting them on the
pygame.org website for others to learn from and enjoy.

Lots of thanks to James Paige for hosting the pygame bugzilla.
Lots of thanks to James Paige for hosting the Pygame bugzilla.

Also a big thanks to Roger Dingledine and the crew at SEUL.ORG for our
excellent hosting.
Expand Down Expand Up @@ -226,10 +226,10 @@ This library is distributed under `GNU LGPL version 2.1`_, which can
be found in the file ``docs/LGPL.txt``. We reserve the right to place
future versions of this library under a different license.

This basically means you can use pygame in any project you want,
but if you make any changes or additions to pygame itself, those
This basically means you can use Pygame in any project you want,
but if you make any changes or additions to Pygame itself, those
must be released with a compatible license (preferably submitted
back to the pygame project). Closed source and commercial games are fine.
back to the Pygame project). Closed source and commercial games are fine.

The programs in the ``examples`` subdirectory are in the public domain.

Expand Down

0 comments on commit 467db56

Please sign in to comment.