Create Examples-README.md

cztomczak · cztomczak · commit 4d2b05ef74de · 2017-03-12T09:50:56.000+01:00
diff --git a/README.md b/README.md
@@ -21,9 +21,9 @@ CEF focuses on facilitating embedded browser use cases in third-party
 applications. Lots of applications use CEF control, there are more than
 [100 million CEF instances]
 (http://en.wikipedia.org/wiki/Chromium_Embedded_Framework#Applications_using_CEF)
-installed around the world. Examples of embedding Chrome browser are
-available for many popular GUI toolkits including: wxPython, PyGTK,
-PyQt, PySide, Kivy, Panda3D and PyGame/PyOpenGL.
+installed around the world. [Examples of embedding](examples/Examples-README.md)
+Chrome browser are available for many popular GUI toolkits including:
+wxPython, PyGTK, PyQt, PySide, Kivy, Panda3D and PyGame/PyOpenGL.
 
 There are many use cases for CEF. You can embed a web browser control
 based on Chromium with great HTML 5 support. You can use it to create
diff --git a/docs/Examples.md b/docs/Examples.md
@@ -0,0 +1,4 @@
+# Examples
+
+Examples are available in the examples/ root directory. See
+[Examples-README.md](../examples/Examples-README.md).
diff --git a/examples/Examples-README.md b/examples/Examples-README.md
@@ -0,0 +1,48 @@
+# Examples
+
+Table of contents:
+* [Supported examples](#supported-examples)
+* [More examples](#more-examples)
+
+
+## Supported examples
+
+Examples provided in the examples/ root directory are actively
+maintained:
+
+- [gtk2.py](gtk2.py): example for [PyGTK](http://www.pygtk.org/)
+  library (GTK 2)
+- [gtk3.py](gtk3.py): example for [PyGObject/PyGI]
+  (https://wiki.gnome.org/Projects/PyGObject) library (GTK 3).
+  Currently broken on Linux/Mac, see top comments in sources.
+- [hello_world.py](hello_world.py): doesn't require any third party
+  GUI framework
+- [qt4.py](qt4.py): example for [PyQt4](https://wiki.python.org/moin/PyQt4)
+  and [PySide](https://wiki.qt.io/PySide) libraries (Qt 4)
+- [tkinter_.py](tkinter_.py): example for [Tkinter]
+  (https://wiki.python.org/moin/TkInter). Currently broken on Mac.
+- [wxpython.py](wxpython.py): example for wxPython
+
+If there are any issues in examples read top comments in sources
+to see whether this is a known issue with available workarounds.
+
+
+## More examples
+
+There are even more examples available, some of them are externally
+maintained. 
+
+- Kivy framework:
+  see [Kivy](https://github.com/cztomczak/cefpython/wiki/Kivy) wiki page.
+- Panda3D game engine:
+  see [Panda3D](https://github.com/cztomczak/cefpython/wiki/Panda3D) wiki page.
+- PyGame/PyOpenGL:
+  see [gist by AnishN](https://gist.github.com/AnishN/aa3bb27fc9d69319955ed9a8973cd40f)
+- Screenshot example:
+  see [gist by stefanbacon](https://gist.github.com/stefanbacon/7b1571d57aee54aa9f8e9021b4848d06)
+- Old PyWin32 example:
+  see [pywin32.py](https://github.com/cztomczak/cefpython/blob/cefpython31/cefpython/cef3/windows/binaries_32bit/pywin32.py)
+  in the cefpython31 branch
+
+There are ongoing efforts to add these examples to the official examples/
+directory, see issues in the tracker.
