Skip to content

Commit e3991e7

Browse files
committed
Initial draft of all README.md files.
1 parent 68f92c0 commit e3991e7

File tree

9 files changed

+166
-1
lines changed

9 files changed

+166
-1
lines changed

browser/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Mooseache — How web browsers would be if they'd just been invented.
2+
3+
This is an example web browser built with Python and Qt. Using the
4+
QtWebEngineWidgets system introduced in Qt5.6, this provides a single-window
5+
browsing experience with the usual controls, as well as saving and loading HTML.
6+
7+
![Browser](screenshot-browser.png)
8+
9+
> If you think this example app is neat and want to learn more about
10+
PyQt in general, [take a look at my ebook & online course
11+
"Create Simple GUI Applications"](https://martinfitzpatrick.name/create-simple-gui-applications)
12+
which covers everything you need to know to start building your own applications with PyQt.
13+
14+
## Other licenses
15+
16+
Icons used in the application are by [Yusuke Kamiyaman](http://p.yusukekamiyamane.com/).

browser_tabbed/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Mozzarella Ashbadger — Upgrade your browsing with tabs
2+
3+
Mozarella Ashbadger is the latest revolution in web
4+
browsing! Go back and forward! Print! Save files! Get help!
5+
(you’ll need it). Any similarity to other browsers is entirely
6+
coincidental.
7+
8+
![Browser tabbed](screenshot-browser-tabbed.png)
9+
10+
> If you think this example app is neat and want to learn more about
11+
PyQt in general, [take a look at my ebook & online course
12+
"Create Simple GUI Applications"](https://martinfitzpatrick.name/create-simple-gui-applications)
13+
which covers everything you need to know to start building your own applications with PyQt.
14+
15+
## Code notes
16+
17+
### Tabbing
18+
19+
Adding tab support complicates the internals of the browser a bit, since we
20+
now need to keep track of the currently active browser view, both to update
21+
UI elements (URL bar, HTTPs icon) to changing state in the currently active
22+
window, and to ensure the UI events are dispatched to the correct web view.
23+
24+
This is achieved by using intermediate slots which filter events, and by
25+
adding signal redirection (using lamba functions to keep it short).
26+
27+
## Other licenses
28+
29+
Icons used in the application are by [Yusuke Kamiyaman](http://p.yusukekamiyamane.com/).

camera/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# NSAViewer — Somebody's watching you.
2+
3+
With this webcam snapshot application you can take photos of what is currently
4+
being viewed by your webcam. Uses the Qt QtMultimedia framework for handling
5+
all the interaction with the camera, and supports multiple cameras if you have
6+
them.
7+
8+
![Camera](screenshot-camera.jpg)
9+
10+
> If you think this example app is neat and want to learn more about
11+
PyQt in general, [take a look at my ebook & online course
12+
"Create Simple GUI Applications"](https://martinfitzpatrick.name/create-simple-gui-applications)
13+
which covers everything you need to know to start building your own applications with PyQt.
14+
15+
## Other licenses
16+
17+
Icons used in the application are by [Yusuke Kamiyaman](http://p.yusukekamiyamane.com/).

camera/screenshot-camera.jpg

112 KB
Loading

minesweeper/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,8 @@ Here we cheat a little bit by taking the first go for the player, ensuring that
3333
it is on a non-mine spot. This allows us not to worry about the bad first move
3434
which would require us to recalculate the adjacencies.
3535
We can explain this away as the "initial exploration around the rocket"
36-
and make it sound completely sensible.
36+
and make it sound completely sensible.
37+
38+
## Other licenses
39+
40+
Icons used in the application are by [Yusuke Kamiyaman](http://p.yusukekamiyamane.com/).

translate/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Translatarrrr — Instant translation from any language to Pirate
2+
3+
A translator from any language (supported by Goolge translate) to pirate.
4+
This uses a remote API from http://api.funtranslations.com for English
5+
to Pirate translation, and a unofficial Python wrapper around Google translate
6+
for other languages to English.
7+
8+
![Translatarrrr](screenshot-translate1.jpg)
9+
10+
The *to English* part uses a Python library built on the web interface,
11+
rather than an official API client since it's a faff to set up + non-free.
12+
This means this part of the application is not guaranteed to work.
13+
14+
![Translatarrrr](screenshot-translate2.jpg)
15+
16+
The *to Pirate* part uses a public API that is heavily throttled. You'll
17+
usually get about 5 translations before the limit kicks in. You can
18+
pay for an API key to get more.
19+
20+
This is, therefore, very useless.
21+
22+
> If you think this example app is neat and want to learn more about
23+
PyQt in general, [take a look at my ebook & online course
24+
"Create Simple GUI Applications"](https://martinfitzpatrick.name/create-simple-gui-applications)
25+
which covers everything you need to know to start building your own applications with PyQt.
26+
27+

unzip/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# 7Pez — the best/worst Unzip application ever created
2+
3+
Unzip your files with a cat. Drag-drop your zip file onto the floaty
4+
cat, and fill up it's Pez-file repository. Press the head to release
5+
the Pez (your files) into the same folder.
6+
7+
When you open the application the catty Pez dispenser is empty.
8+
9+
![Unzip](screenshot-unzip1.jpg)
10+
11+
Simply drag and drop your .zip file onto the cat to fill it up with Pez.
12+
13+
![Unzip](screenshot-unzip2.jpg)
14+
15+
The press the cat's head to release the Pez.
16+
17+
> If you think this example app is neat and want to learn more about
18+
PyQt in general, [take a look at my ebook & online course
19+
"Create Simple GUI Applications"](https://martinfitzpatrick.name/create-simple-gui-applications)
20+
which covers everything you need to know to start building your own applications with PyQt.
21+
22+
23+
## Code notes
24+
25+
### Pez
26+
27+
If you know anything about Pez you'll know this application has it the wrong
28+
way around. That's because I remembered it wrong, thinking that you pressed
29+
the head of a Pez dispenser to make it drop Pez out the bottom.
30+
31+
Originally the intention was to make you press the head once for every file
32+
you wanted to release, but that was excruciating. It's bad enough as it is.
33+
34+

weather/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Raindar — A weather forecase app built in PyQt.
2+
3+
Get your daily weather and 15hr forecast. Data is provided by the free
4+
weather and forecast API from https://openweathermap.org/
5+
6+
![Weather](screenshot-weather.png)
7+
8+
> If you think this example app is neat and want to learn more about
9+
PyQt in general, [take a look at my ebook & online course
10+
"Create Simple GUI Applications"](https://martinfitzpatrick.name/create-simple-gui-applications)
11+
which covers everything you need to know to start building your own applications with PyQt.
12+
13+
## Other licenses
14+
15+
Icons used in the application are by [Yusuke Kamiyaman](http://p.yusukekamiyamane.com/).
16+
They were renamed to match codes generated by OpenWeatherMap.

wordprocessor/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Megasolid Idiom — A rich text editor in PyQt
2+
3+
The word processor for all your small, poorly formatted documents.
4+
An extension of the notepad, again using a QTextEdit but with rich
5+
text editing enabled.
6+
7+
The editor supports multiple fonts, styles and paragraph text alignment.
8+
There is also support for drag-drop of images, which are automatically
9+
opened and embedded.
10+
11+
Saves and opens HTML format documents.
12+
13+
![Wordprocessor](screenshot-wordprocessor.jpg)
14+
15+
> If you think this example app is neat and want to learn more about
16+
PyQt in general, [take a look at my ebook & online course
17+
"Create Simple GUI Applications"](https://martinfitzpatrick.name/create-simple-gui-applications)
18+
which covers everything you need to know to start building your own applications with PyQt.
19+
20+
## Other licenses
21+
22+
Icons used in the application are by [Yusuke Kamiyaman](http://p.yusukekamiyamane.com/).

0 commit comments

Comments
 (0)