Skip to content

Revamp #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Sep 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .github/workflows/chrome_ci.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
name: Google Chrome CI

on: [push, pull_request]
on:
push:
branches:
main
pull-request:
branches:
main

jobs:
build:
Expand Down
8 changes: 7 additions & 1 deletion .github/workflows/electron_ci.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
name: Electron CI

on: [push, pull_request]
on:
push:
branches:
main
pull-request:
branches:
main

jobs:
build:
Expand Down
11 changes: 0 additions & 11 deletions cypress/pages/classPage.js

This file was deleted.

11 changes: 0 additions & 11 deletions cypress/pages/fontPage.js

This file was deleted.

11 changes: 0 additions & 11 deletions cypress/pages/setupPage.js

This file was deleted.

87 changes: 87 additions & 0 deletions guide/intro/chapter-1/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
layout: default
title: What is Pygame
next_page: [/guide/intro/chapter-2, Opening A Window]
---

<body>
<p>In this article, we'll go over what pygame is and how to install it.</p>

<h2>Table of contents</h2>
<p></p>
<ol id="toc">
<!--
To be filled by javascript
-->
</ol>

<h2><a id="introduction" class="js">Introduction</a></h2>
<p>
It's time to get started on your pygame journey, but what is pygame? Well
pygame is "a free and open-source cross-platform library for the development
of multimedia applications like video games using Python"(<a href="https://github.com/pygame-community/pygame-ce?tab=readme-ov-file">pygame-ce github repository</a>). As the
description suggests, it's mostly used to make video games - which is why in
this book we'll be learning techniques relevant to making games
</p>

<p>
Pygame aims to be a user-friendly library to draw and manipulate pixels onto
the screen, much like <a href="https://www.libsdl.org/">SDL2</a>, but with
extended features in various forms that makes it easier to use. Given this
nature, you generally have a lot of control on how you want your code to
run, so it may have a bit of a learning curve. But fear not! After reading
this book you should be able to use pygame just fine, as long as you get
your practice in 🔫
</p>

<p>
In this book we'll aim to cover how to do basic things with pygame, with
little exercises in between to make sure you're not falling off

Good Luck!
</p>

<h2><a id="pygame-ce" class="js">Pygame-CE</a></h2>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This whole section makes a large number of bold claims, but doesn't provide any supporting evidence for it. I suggest instead linking to some external party dialogues and briefly summarizing the differences instead. The drama part is not really important to the average noob and I suspect the heavy bias here might rub people the wrong way

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This whole section makes a large number of bold claims

Which ones?

I suspect the heavy bias here might rub people the wrong way

Hmm, I think removing the last sentence might fix it: "It is recommended to use only pygame-ce from now onwards by most Python communities."

The drama part is not really important to the average noob

I don't really think I dwelt too deep into the drama, I just mentioned how pygame-ce was formed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this line
"Well, pygame-ce has no "owner", it follows a more democratic approach to managing itself now."

Could be changed to
"pygame-ce is not owned by any one person and follows a more democratic model to its management"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this is how it would be now:
So pygame currently has two major distributors, the original one and a fork of the project. What is a fork? Well it means it's a copy of the project, and in this case they branched off to be two completely separate packages now.

pygame-ce is a fork of the original pygame, which got created due to all the active developers of the original project being banned by the "owner". The fork is not owned by any one person and follows a more democratic model to its management

So what happened to all the active developers of the original pygame? They formed pygame-ce! That's right, so pygame-ce is being developed by the same people (and more) as the original pygame, and with a more democratic model have been able to push releases way more easily and introduce many more features.

For all sane purposes, we will be using pygame-ce in this book and we advise the same. It has had more performance improvements, code features, and active development than the original pygame for a while now.

<p>
So pygame currently has two major distributors, the original one and a fork
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Starting a sentence with "So" feels wrong, suggest opening with something different.

Suggested change
So pygame currently has two major distributors, the original one and a fork
In the event that you weren't aware, pygame currently has two major distributions, the original one and a fork

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the event that you weren't aware

I feel like this is too formal? In English it's valid to start sentences with "So" afaik. In formal writing it's frowned upon - but I was trying to go for a more friendly and engaging vibe for the whole article/book. This isn't necessarily unfriendly, of course, but I feel being too formal makes it less engaging
But if we really dont want to move forward with "So", I think we should look for an alternative as "In the event that you weren't aware" feels too formal
I'd say "In case you didn't know, " or just starting off with "Pygame has two major distributions" (but I do feel like adding "So" would be more engaging, we should poll on this maybe)

of the project. What is a fork? Well it means it's a copy of the project, and
in this case they branched off to be two completely separate packages now.
</p>
<p>
<a href="https://github.com/pygame-community/pygame-ce">pygame-ce</a> is a
fork of the original pygame, which got created due to all the active
developers of the original project being banned by the "owner". The fork is not owned
by any one person and follows a more democratic model to its management
</p>
<p>
So what happened to all the active developers of the original pygame? They
formed pygame-ce! That's right, so pygame-ce is being developed by the same
people (and more) as the original pygame, and with a more democratic model
have been able to push releases way more easily and introduce many more
features.
</p>
<p>
For all sane purposes, we will be using <code>pygame-ce</code> in this book
and we advise the same. It has had more performance improvements, code
features, and active development than the original pygame for a while now.
</p>

<h2><a id="installation" class="js">Installation</a></h2>
<p>
Now that you know what pygame-ce is, let's install it.

<pre>
pip uninstall pygame
pip install pygame-ce
</pre>
In order for pygame-ce to work, pygame needs to be uninstalled first.
This is because both upstream pygame and pygame-ce share the import name,
and so upstream pygame must be removed <u>first</u>.
</p>
<p>
I simply included it as the first step in order to install pygame-ce in a foolproof manner with no issues,
but I must remind you that a pre-requisite of using this site is knowing how to manage your
environment, so please do learn that if you havent already
</p>

</body>
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Empty file.
Empty file.
Empty file.
Loading