Skip to content

Commit ee46c0f

Browse files
committed
Update README's - hello world example and documentation search
1 parent ea14b98 commit ee46c0f

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@ See the [Examples-README.md](examples/Examples-README.md) file.
6161
- Documentation is in the [docs/](docs) directory
6262
- API reference is in the [api/](api) directory
6363
- Additional documentation is in issues labelled [Knowledge Base](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22)
64+
- To search documentation use GitHub "This repository" search
65+
at the top. To narrow results to documentation only select
66+
"Markdown" in the left pane.
6467
- Wiki pages are deprecated and for v31 only
6568

6669

examples/Examples-README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,40 @@
11
# Examples README
22

33
Table of contents:
4+
* [Hello World!](#hello-world)
45
* [Supported examples](#supported-examples)
56
* [More examples](#more-examples)
67

8+
## Hello World!
9+
10+
Instructions to install the cefpython3 package, clone the repository
11+
and run the hello_world.py example:
12+
13+
```
14+
pip install cefpython3==56.1
15+
git clone https://github.com/cztomczak/cefpython.git
16+
cd cefpython/
17+
python hello_world.py
18+
```
19+
720

821
## Supported examples
922

1023
Examples provided in the examples/ root directory are actively
1124
maintained:
1225

26+
- [hello_world.py](hello_world.py): basic example, doesn't require any
27+
third party GUI framework to run
1328
- [gtk2.py](gtk2.py): example for [PyGTK](http://www.pygtk.org/)
1429
library (GTK 2)
1530
- [gtk3.py](gtk3.py): example for [PyGObject/PyGI](https://wiki.gnome.org/Projects/PyGObject)
1631
library (GTK 3). Currently broken on Linux/Mac, see top comments in sources.
17-
- [hello_world.py](hello_world.py): doesn't require any third party
18-
GUI framework
1932
- [qt4.py](qt4.py): example for [PyQt4](https://wiki.python.org/moin/PyQt4)
2033
and [PySide](https://wiki.qt.io/PySide) libraries (Qt 4)
2134
- [tkinter_.py](tkinter_.py): example for [Tkinter](https://wiki.python.org/moin/TkInter).
2235
Currently broken on Mac.
2336
- [wxpython.py](wxpython.py): example for [wxPython](https://wxpython.org/)
37+
toolkit
2438

2539
If there are any issues in examples read top comments in sources
2640
to see whether this is a known issue with available workarounds.

0 commit comments

Comments
 (0)