Skip to content

Commit 264ce18

Browse files
committed
Update README - add support matrixes and install/examples sections
1 parent 9537590 commit 264ce18

File tree

2 files changed

+41
-23
lines changed

2 files changed

+41
-23
lines changed

README.md

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
Table of contents:
44
* [Introduction](#introduction)
5+
* [Install](#install)
6+
* [Examples](#examples)
57
* [Support](#support)
68
* [Releases](#releases)
7-
* [v50+ releases](#v50-releases)
9+
* [v56+ releases](#v56-releases)
810
* [v31 release](#v31-release)
911
* [Support development](#support-development)
1012
* [Thanks](#thanks)
@@ -38,6 +40,21 @@ applications. You can use it for web scraping or as a web crawler,
3840
or other kind of internet bots.
3941

4042

43+
## Install
44+
45+
You can install with pip. On Linux pip 8.1+ is required. You can
46+
also download packages for offline installation available on the
47+
[GitHub Releases](../../releases) pages.
48+
49+
```
50+
pip install cefpython3==56.1
51+
```
52+
53+
## Examples
54+
55+
See the [Examples-README.md](examples/Examples-README.md) file.
56+
57+
4158
## Support
4259

4360
- Ask questions, report problems and issues on the [Forum](https://groups.google.com/group/cefpython)
@@ -49,28 +66,30 @@ or other kind of internet bots.
4966

5067
## Releases
5168

52-
### v50+ releases
69+
Information on supported platforms, python versions, architectures
70+
and requirements. If you want to support old operating systems then
71+
choose the v31 release.
5372

54-
- Can be installed on all platforms using `pip install cefpython3` command
55-
- Downloads are available on [GitHub Releases](../../releases) pages
56-
- Windows support: 32-bit and 64-bit, Python 2.7 / 3.4 / 3.5 / 3.6
57-
(requirements: Windows 7+)
58-
- Linux support: 32-bit and 64-bit, Python 2.7 / 3.4 / 3.5 / 3.6
59-
(requirements: Debian 7+ / Ubuntu 12.04+)
60-
- Mac support: 64-bit, Python 2.7 / 3.4 / 3.5 / 3.6
61-
(requirements: MacOS 10.9+)
62-
- Documentation is in the [docs/](docs) directory
63-
- API reference is in the [api/](api) directory
64-
- Additional documentation is in issues labelled [Knowledge Base](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22)
73+
### v56+ releases
74+
75+
OS | Py2 | Py3 | 32bit | 64bit | Requirements
76+
--- | --- | --- | --- | --- | ---
77+
Windows | 2.7 | 3.4 / 3.5 / 3.6 | Yes | Yes | Windows 7+
78+
Linux | 2.7 | 3.4 / 3.5 / 3.6 | Yes | Yes | Debian 7+ / Ubuntu 12.04+
79+
Mac | 2.7 | 3.4 / 3.5 / 3.6 | No | Yes | MacOS 10.9+
6580

6681
### v31 release
6782

83+
OS | Py2 | Py3 | 32bit | 64bit | Requirements
84+
--- | --- | --- | --- | --- | ---
85+
Windows | 2.7 | No | Yes | Yes | Windows XP+
86+
Linux | 2.7 | No | Yes | Yes | Debian 7+ / Ubuntu 12.04+
87+
Mac | 2.7 | No | Yes | Yes | MacOS 10.7+
88+
89+
Additional information for v31.2 release:
90+
- On Windows/Mac you can install with command: `pip install cefpython3==31.2`
6891
- Downloads are available on [wiki pages](../../wiki#downloads)
69-
and on GH Releases tagged [v31.2](../../releases/tag/v31.2)
70-
- Supports only Python 2.7
71-
- Windows support: 32-bit and 64-bit (requirements: Windows XP+)
72-
- Linux support: 32-bit and 64-bit (requirements: Debian 7+ / Ubuntu 12.04+)
73-
- Mac support: 32-bit and 64-bit (requirements: MacOS 10.7+)
92+
and on GitHub Releases tagged [v31.2](../../releases/tag/v31.2).
7493
- Documentation is on [wiki pages](../../wiki)
7594
- API reference is available in revision [169a1b2](../../tree/169a1b20d3cd09879070d41aab28cfa195d2a7d5/docs/api)
7695

examples/Examples-README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,14 @@ maintained:
1212

1313
- [gtk2.py](gtk2.py): example for [PyGTK](http://www.pygtk.org/)
1414
library (GTK 2)
15-
- [gtk3.py](gtk3.py): example for [PyGObject/PyGI]
16-
(https://wiki.gnome.org/Projects/PyGObject) library (GTK 3).
17-
Currently broken on Linux/Mac, see top comments in sources.
15+
- [gtk3.py](gtk3.py): example for [PyGObject/PyGI](https://wiki.gnome.org/Projects/PyGObject)
16+
library (GTK 3). Currently broken on Linux/Mac, see top comments in sources.
1817
- [hello_world.py](hello_world.py): doesn't require any third party
1918
GUI framework
2019
- [qt4.py](qt4.py): example for [PyQt4](https://wiki.python.org/moin/PyQt4)
2120
and [PySide](https://wiki.qt.io/PySide) libraries (Qt 4)
22-
- [tkinter_.py](tkinter_.py): example for [Tkinter]
23-
(https://wiki.python.org/moin/TkInter). Currently broken on Mac.
21+
- [tkinter_.py](tkinter_.py): example for [Tkinter](https://wiki.python.org/moin/TkInter).
22+
Currently broken on Mac.
2423
- [wxpython.py](wxpython.py): example for [wxPython](https://wxpython.org/)
2524

2625
If there are any issues in examples read top comments in sources

0 commit comments

Comments
 (0)