From 1c80d8cfe57689ad81dad0a2db0e0423a7b3bb70 Mon Sep 17 00:00:00 2001 From: Michael Herrmann Date: Mon, 1 Jul 2019 17:14:40 +0200 Subject: [PATCH] Fix README links on GitHub mobile --- src/01 PyQt QLabel/README.md | 2 +- src/02 PyQt Widgets/README.md | 2 +- src/03 QVBoxLayout PyQt5/README.md | 2 +- src/04 PyQt Signals and Slots/README.md | 2 +- src/05 Qt Designer Python/README.md | 2 +- src/06 QML Python example/README.md | 2 +- src/07 Qt Text Editor/README.md | 2 +- src/08 PyQt5 exe/README.md | 2 +- src/09 Qt dark theme/README.md | 2 +- src/10 QPainter Python example/README.md | 2 +- src/11 PyQt Thread example/README.md | 2 +- src/12 QTreeView example in Python/README.md | 2 +- src/13 PyQt5 QListView/README.md | 2 +- src/14 QAbstractTableModel example/README.md | 2 +- src/15 PyQt database example/README.md | 2 +- 15 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/01 PyQt QLabel/README.md b/src/01 PyQt QLabel/README.md index 129f16c..ca56f98 100644 --- a/src/01 PyQt QLabel/README.md +++ b/src/01 PyQt QLabel/README.md @@ -12,7 +12,7 @@ label.show() app.exec_() ``` -For instructions how you can run this code, please see the [top-level README](https://github.com/pyqt/examples#running-the-examples). +For instructions how you can run this code, please see the [top-level README](../../README.md#running-the-examples). The code works as follows: First, we import the necessary PyQt classes via the statement: diff --git a/src/02 PyQt Widgets/README.md b/src/02 PyQt Widgets/README.md index 9773c53..b65dea6 100644 --- a/src/02 PyQt Widgets/README.md +++ b/src/02 PyQt Widgets/README.md @@ -18,4 +18,4 @@ Some of the widgets you can see in this screenshot are: * [QSlider](https://doc.qt.io/qt-5/qslider.html) * [QProgressBar](https://doc.qt.io/qt-5/qprogressbar.html) -The source code for this application is in [`main.py`](main.py). For instructions how to run it, please see [here](https://github.com/pyqt/examples#running-the-examples). Don't worry if you don't yet fully understand the source code. The main purpose of this example is to give you a feel for what a widget is, and which ones are available. The next examples give you a more gradual route to more advanced PyQt topics. +The source code for this application is in [`main.py`](main.py). For instructions how to run it, please see [here](../../README.md#running-the-examples). Don't worry if you don't yet fully understand the source code. The main purpose of this example is to give you a feel for what a widget is, and which ones are available. The next examples give you a more gradual route to more advanced PyQt topics. diff --git a/src/03 QVBoxLayout PyQt5/README.md b/src/03 QVBoxLayout PyQt5/README.md index d594fd6..3e98be1 100644 --- a/src/03 QVBoxLayout PyQt5/README.md +++ b/src/03 QVBoxLayout PyQt5/README.md @@ -36,6 +36,6 @@ We conclude by showing the window and (as is required) handing control over to Q window.show() app.exec_() -For instructions how you can run this example yourself, please see [here](https://github.com/pyqt/examples#running-the-examples). +For instructions how you can run this example yourself, please see [here](../../README.md#running-the-examples). The related [`QHBoxLayout`](https://doc.qt.io/qt-5/qhboxlayout.html) positions items horizontally. For an even more powerful approach, see [`QGridLayout`](https://doc.qt.io/qt-5/qgridlayout.html). diff --git a/src/04 PyQt Signals and Slots/README.md b/src/04 PyQt Signals and Slots/README.md index 06276e3..8cd64ab 100644 --- a/src/04 PyQt Signals and Slots/README.md +++ b/src/04 PyQt Signals and Slots/README.md @@ -29,4 +29,4 @@ Finally, we show the button on the screen and hand control over to Qt: button.show() app.exec_() -For instructions how you can run this example yourself, please see [here](https://github.com/pyqt/examples#running-the-examples). +For instructions how you can run this example yourself, please see [here](../../README.md#running-the-examples). diff --git a/src/05 Qt Designer Python/README.md b/src/05 Qt Designer Python/README.md index 80378fe..1266030 100644 --- a/src/05 Qt Designer Python/README.md +++ b/src/05 Qt Designer Python/README.md @@ -44,4 +44,4 @@ We've now connected the necessary components for displaying the user interface g window.show() app.exec_() -For instructions how to run this example yourself, please see [here](https://github.com/pyqt/examples#running-the-examples). +For instructions how to run this example yourself, please see [here](../../README.md#running-the-examples). diff --git a/src/06 QML Python example/README.md b/src/06 QML Python example/README.md index d0c7898..37ef628 100644 --- a/src/06 QML Python example/README.md +++ b/src/06 QML Python example/README.md @@ -53,6 +53,6 @@ engine.load("main.qml") app.exec_() ``` -If you'd like further instructions how you can run this code for yourself, please see [here](https://github.com/pyqt/examples#running-the-examples). +If you'd like further instructions how you can run this code for yourself, please see [here](../../README.md#running-the-examples). Some code in this directory has special license requirements. For more information, please see [`LICENSE.md`](LICENSE.md). diff --git a/src/07 Qt Text Editor/README.md b/src/07 Qt Text Editor/README.md index 6234ef5..ce8e423 100644 --- a/src/07 Qt Text Editor/README.md +++ b/src/07 Qt Text Editor/README.md @@ -15,4 +15,4 @@ It has a surprising number of features: * An *About* dialog. * A warning *Do you want to save before quitting?* if there are unmodified changes. -The full source code is in [`main.py`](main.py). For instructions on how to run it, please see [here](https://github.com/pyqt/examples#running-the-examples). +The full source code is in [`main.py`](main.py). For instructions on how to run it, please see [here](../../README.md#running-the-examples). diff --git a/src/08 PyQt5 exe/README.md b/src/08 PyQt5 exe/README.md index 07c2845..119cb28 100644 --- a/src/08 PyQt5 exe/README.md +++ b/src/08 PyQt5 exe/README.md @@ -38,7 +38,7 @@ Because we didn't create the `QApplication` ourselves, we finally use the follow appctxt.app.exec_() -To run this example yourself, you need fbs installed as per the instructions [here](https://github.com/pyqt/examples#running-the-examples). Then, you can do use the following command to run the text editor: +To run this example yourself, you need fbs installed as per the instructions [here](../../README.md#running-the-examples). Then, you can do use the following command to run the text editor: fbs run diff --git a/src/09 Qt dark theme/README.md b/src/09 Qt dark theme/README.md index 232d5f6..8b41f67 100644 --- a/src/09 Qt dark theme/README.md +++ b/src/09 Qt dark theme/README.md @@ -18,4 +18,4 @@ As you can see in [`main.py`](main.py), this example uses `QApplication.setStyle The rest of the code is the same as for the [original version of the text editor](../07%20Qt%20Text%20Editor). -To run this example yourself, please follow the [instructions in the README of this repository](https://github.com/pyqt/examples#running-the-examples). +To run this example yourself, please follow the [instructions in the README of this repository](../../README.md#running-the-examples). diff --git a/src/10 QPainter Python example/README.md b/src/10 QPainter Python example/README.md index 1a14302..258d626 100644 --- a/src/10 QPainter Python example/README.md +++ b/src/10 QPainter Python example/README.md @@ -6,4 +6,4 @@ This example application demonstrates how you can use [`QPainter`](https://doc.q The crucial steps of this example are to [override `mousePressEvent(...)`](main.py#L13-L17) to handle the user's clicks, and [`paintEvent(...)`](main.py#L18-L22) to draw the bullets. See the top of [`main.py`](main.py) for how these features work in detail. -To run this example yourself, please follow [these instructions](https://github.com/pyqt/examples#running-the-examples). +To run this example yourself, please follow [these instructions](../../README.md#running-the-examples). diff --git a/src/11 PyQt Thread example/README.md b/src/11 PyQt Thread example/README.md index cbf1255..9a8c7fc 100644 --- a/src/11 PyQt Thread example/README.md +++ b/src/11 PyQt Thread example/README.md @@ -4,7 +4,7 @@ This example shows how you can use threads to make your PyQt application more re

PyQt Thread Example

-To run this example, please follow [the instructions in the README of this repository](https://github.com/pyqt/examples#running-the-examples). Instead of `python main.py`, use `python` to execute one of the scripts described below. Eg. `python 01_single_threaded.py`. +To run this example, please follow [the instructions in the README of this repository](../../README.md#running-the-examples). Instead of `python main.py`, use `python` to execute one of the scripts described below. Eg. `python 01_single_threaded.py`. To demonstrate the utility of threads, this directory contains multiple implementations of the chat client: diff --git a/src/12 QTreeView example in Python/README.md b/src/12 QTreeView example in Python/README.md index 9134acf..1dbaf6e 100644 --- a/src/12 QTreeView example in Python/README.md +++ b/src/12 QTreeView example in Python/README.md @@ -20,4 +20,4 @@ The nice thing about the Model/View distinction is that it lets you visualize th The next example, [PyQt5 QListview](../13%20PyQt5%20QListView), shows another way of using `QListView`. -To run this example yourself, please follow [the instructions in the README of this repository](https://github.com/pyqt/examples#running-the-examples). +To run this example yourself, please follow [the instructions in the README of this repository](../../README.md#running-the-examples). diff --git a/src/13 PyQt5 QListView/README.md b/src/13 PyQt5 QListView/README.md index df17483..9aea758 100644 --- a/src/13 PyQt5 QListView/README.md +++ b/src/13 PyQt5 QListView/README.md @@ -15,4 +15,4 @@ view.show() This is very similar to the [previous example](../12%20QTreeView%20example%20in%20Python), where we displayed a tree view of files. The reason for this similarity is that both examples use Qt's Model/View framework. As an exercise for yourself, you might want to try using `QListView` instead of `QTreeView` in the previous example. -To run this example, please follow [the instructions in the README of this repository](https://github.com/pyqt/examples#running-the-examples). +To run this example, please follow [the instructions in the README of this repository](../../README.md#running-the-examples). diff --git a/src/14 QAbstractTableModel example/README.md b/src/14 QAbstractTableModel example/README.md index 92f3840..132bd07 100644 --- a/src/14 QAbstractTableModel example/README.md +++ b/src/14 QAbstractTableModel example/README.md @@ -49,4 +49,4 @@ Once we have this model, we can instantiate it, connect it to a `QTableView` and view.setModel(model) view.show() -The full code is in [`main.py`](main.py). For instructions how to run it, please see [the instructions in the README of this repository](https://github.com/pyqt/examples#running-the-examples). +The full code is in [`main.py`](main.py). For instructions how to run it, please see [the instructions in the README of this repository](../../README.md#running-the-examples). diff --git a/src/15 PyQt database example/README.md b/src/15 PyQt database example/README.md index bf5d736..f40999e 100644 --- a/src/15 PyQt database example/README.md +++ b/src/15 PyQt database example/README.md @@ -35,6 +35,6 @@ view.show() As in [previous examples](../12%20QTreeView%20example%20in%20Python), this uses Qt's Model/View framework to separate the two concerns of obtaining and displaying the data: We use `model` to load the database, and `view` to display it. -To run this example yourself, first follow [these instructions](https://github.com/pyqt/examples#running-the-examples). Then invoke `python initdb.py` to initialize the database. After that, you can execute `python main.py` to start the sample application. +To run this example yourself, first follow [these instructions](../../README.md#running-the-examples). Then invoke `python initdb.py` to initialize the database. After that, you can execute `python main.py` to start the sample application. While we use SQLite here, you can easily use other database systems as well. For instance, you could use PostgreSQL via the [psycopg2](http://initd.org/psycopg/) library.