Skip to content

Commit 919a2b5

Browse files
committed
Add README and LICENSE
1 parent 8377ece commit 919a2b5

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

README.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
PythonQt
22
========
33

4-
This project is an unofficial fork of [PythonQt](http://pythonqt.sourceforge.net/) sources
5-
hosted on sourceforge and is used as staging area to maintain and test patches that
6-
will then be contributed back to the official repository.
4+
Why is this project ?
5+
---------------------
6+
7+
This project is **NOT** the official PythonQt repository.
8+
9+
It is a fork of [PythonQt](http://pythonqt.sourceforge.net/) sources hosted on sourceforge
10+
adding support for [CMake](https://cmake.org) build system.
11+
12+
It is used as staging area to maintain and test patches that will be contributed back to the
13+
official repository.
714

815
What is PythonQt ?
916
------------------
1017

11-
PythonQt is a dynamic [Python](http://www.python.org) binding for [Qt](http://qt.nokia.com).
12-
It offers an easy way to embed the Python scripting language into
13-
your Qt applications.
18+
PythonQt is a dynamic Python binding for Qt. It offers an easy way to embed the Python
19+
scripting language into your Qt applications.
1420

1521
Prerequisites
1622
-------------
@@ -154,23 +160,15 @@ Once you've made your great commits:
154160

155161
1. [Fork][fk] PythonQt
156162
2. Create a topic branch - `git checkout -b my_branch`
157-
3. Push to your branch - `git push origin my_branch`
158-
4. Create an [Issue][is] with a link to your branch
163+
3. Push to your fork - `git push origin my_branch`
164+
4. Create an [Pull Request][pr]
159165
5. That's it!
160166

161-
162-
Meta
163-
----
164-
165-
* Code: `git clone git://github.com/commontk/PythonQt.git`
166-
* Home: <http://pythonqt.sourceforge.net/>
167-
* Bugs: <http://github.com/commontk/PythonQt/issues>
168-
169167
License
170168
-------
171169

172170
PythonQt is licensed under the GNU Lesser General Public License.
173171

174172
[fk]: http://help.github.com/forking/
175-
[is]: http://github.com/commontk/PythonQt/issues
173+
[pr]: https://help.github.com/articles/creating-a-pull-request/
176174

0 commit comments

Comments
 (0)