Skip to content

Commit bbc8f47

Browse files
cztomczakcztomczak
committed
Update README - fix link and other minor changes.
1 parent edac70b commit bbc8f47

File tree

1 file changed

+37
-10
lines changed

1 file changed

+37
-10
lines changed

‎README.md‎

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Table of contents:
1515
* [Changes in API during updates](#changes-in-api-during-updates)
1616
* [Donate](#donate)
1717

18+
1819
## Important notes
1920

2021
* Branches cefpython51/52/53+ with latest Chrome are tested and work only
@@ -31,31 +32,55 @@ Table of contents:
3132

3233
## Introduction
3334

34-
CEF Python is an open source project founded by [Czarek Tomczak](http://www.linkedin.com/in/czarektomczak) in 2012 to provide python bindings for the [Chromium Embedded Framework](https://bitbucket.org/chromiumembedded/cef). See the growing list of [applications using CEF](http://en.wikipedia.org/wiki/Chromium_Embedded_Framework#Applications_using_CEF) on wikipedia. Examples of embedding CEF browser are available for many popular GUI toolkits including: [wxPython](../../wiki/wxPython), [PyGTK](../../wiki/PyGTK), [PyQt](../../wiki/PyQt), [PySide](../../wiki/PySide), [Kivy](../../wiki/Kivy), [Panda3D](../../wiki/Panda3D) and [PyWin32](src/windows/binaries_32bit/pywin32.py).
35+
CEF Python is an open source project founded by
36+
[Czarek Tomczak](http://www.linkedin.com/in/czarektomczak)
37+
in 2012 to provide python bindings for the
38+
[Chromium Embedded Framework](https://bitbucket.org/chromiumembedded/cef).
39+
See the growing list of
40+
[applications using CEF](http://en.wikipedia.org/wiki/Chromium_Embedded_Framework#Applications_using_CEF)
41+
on wikipedia. Examples of embedding CEF browser are available for many popular
42+
GUI toolkits including: [wxPython](../../wiki/wxPython),
43+
[PyGTK](../../wiki/PyGTK), [PyQt](../../wiki/PyQt),
44+
[PySide](../../wiki/PySide), [Kivy](../../wiki/Kivy),
45+
[Panda3D](../../wiki/Panda3D)
46+
and [PyWin32](src/windows/binaries_32bit/pywin32.py).
3547

3648
Some use cases for CEF:
3749

3850
* Embed a web browser control with great HTML5 support (based on Chromium)
39-
* Use it to create a HTML5 based GUI in an application. This can act as a replacement for GUI toolkits like wxWidgets/Qt/Gtk. For native communication between javascript and python use [javascript bindings](../../wiki/JavascriptBindings). Another option is to run an internal python web server and use websockets/XMLHttpRequest for js<>python communication. This way you can write a desktop app in the same way you write web apps.
40-
* Render web content off-screen in applications that use custom drawing frameworks. See the [Kivy](../../wiki/Kivy) and [Panda3D](../../wiki/Panda3D) examples.
41-
* Use it for automated testing of existing web applications. Use it for web scraping, or as a web crawler or other kind of internet bots.
51+
* Use it to create a HTML5 based GUI in an application. This can act as a
52+
replacement for GUI toolkits like wxWidgets/Qt/Gtk. For native communication
53+
between javascript and python use
54+
[javascript bindings](api/JavascriptBindings.md).
55+
Another option is to run an internal python web server and use
56+
websockets/XMLHttpRequest for js<>python communication. This way you
57+
can write a desktop app in the same way you write web apps.
58+
* Render web content off-screen in applications that use custom drawing
59+
frameworks. See the [Kivy](../../wiki/Kivy)
60+
and [Panda3D](../../wiki/Panda3D) examples.
61+
* Use it for automated testing of existing web applications. Use it for web
62+
scraping, or as a web crawler or other kind of internet bots.
4263

4364

4465
## Compatibility
4566

4667
* Supported Python versions: 2.7
4768
(for Python 3.4 / 3.5 support see [Issue #121](../../issues/121)).
48-
* Supported platforms: Windows, Linux, Mac. Both 32bit and 64bit binaries are available for all platforms.
69+
* Supported platforms: Windows, Linux, Mac.<br>
70+
Both 32-bit and 64-bit binaries are available for all platforms.
4971

5072

5173
## Downloads
5274

5375
On Win/Mac you can install from PyPI using this command:
5476
`pip install cefpython3`.
5577

56-
* For Windows: see the [Download_CEF3_Windows](../../wiki/Download_CEF3_Windows) wiki page.
57-
* For Linux: see the [Download_CEF3_Linux](../../wiki/Download_CEF3_Linux) wiki page.
58-
* For Mac: see the [Download_CEF3_Mac](../../wiki/Download_CEF3_Mac) wiki page.
78+
* For Windows: see the
79+
[Download_CEF3_Windows](../../wiki/Download_CEF3_Windows) wiki page.
80+
* For Linux: see the
81+
[Download_CEF3_Linux](../../wiki/Download_CEF3_Linux) wiki page.
82+
* For Mac: see the
83+
[Download_CEF3_Mac](../../wiki/Download_CEF3_Mac) wiki page.
5984

6085
To be notified when new downloads are available see the
6186
[Notifications on new releases](#notifications-on-new-releases) section.
@@ -66,7 +91,8 @@ To be notified when new downloads are available see the
6691
* Documentation:
6792
* See [API docs](api/) in the api/ directory
6893
* See [Wiki Pages](../../wiki)
69-
* See issues with the [Knowledge Base](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22)
94+
* See issues with the
95+
[Knowledge Base](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22)
7096
label
7197
* Ask questions and report problems on the
7298
[Forum](https://groups.google.com/group/cefpython)
@@ -102,4 +128,5 @@ file then list the cefpython3 package in the following format:
102128

103129
## Donate
104130

105-
If you would like to support general CEF Python development efforts by making a donation see the [Donations](../../wiki/Donations) wiki page.
131+
If you would like to support general CEF Python development efforts by
132+
making a donation see the [Donations](../../wiki/Donations) wiki page.

0 commit comments

Comments
 (0)