Skip to content

Commit 94ef9e1

Browse files
first draft of useful readme
1 parent 4db9f06 commit 94ef9e1

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,45 @@
11
wxPythonDemos
22
=============
33

4-
wxPython Demos: Various small demos of wxPython features -- dveloped over years of discussion on the wxPython-users mailinglist
4+
wxPython Demos: Various small demos of wxPython features -- developed over years of discussion on the wxPython-users mailinglist.
5+
6+
This is a collection of a bunch of mini apps, each designed to test one
7+
small piece of wxPython.
8+
9+
Some of these were done in response to things I was trying to figure out
10+
myself, and some to help answer a question on the wxPython-users list.
11+
12+
Some of the code I wrote myself, and some was written by other folks on
13+
the list, and edited by me.
14+
15+
Note that these were written over a long period of time, with a lot of
16+
wxPython versions. They may not all run under the latest version, and
17+
some of them are written in very outdated style.
18+
19+
Please don't imitate all the style you see here. For a description of
20+
good, modern pythonic style, see:
21+
22+
http://wiki.wxpython.org/index.cgi/wxPython_Style_Guide
23+
24+
Despite these flaws, I think there is a lot to be learned from this
25+
collection.
26+
27+
I suggest you search or grep for a widget you may want to learn somethign about, or just fire up each one and see what it does!
28+
29+
To Do
30+
----------
31+
32+
One of these days, I'd like to go through the code and clean it all up -- proper modern style, testing on recent wxPyton versions and all OSs, etc.
33+
34+
It would also be great to put in more documentation -- maybe a Sphinx auto-generated doc.
35+
36+
Contributing
37+
--------------
38+
If you'd like to help out, please feel free to clone the repository and send me pull requests. If you think you'd like to do a fair bit over a period of time, ask me about getting commit privileges.
39+
40+
41+
-Chris Barker
42+
43+
44+
45+

0 commit comments

Comments
 (0)