davemds pushed a commit to branch master.
http://git.enlightenment.org/bindings/python/python-efl.git/commit/?id=dcf362b03f60fadfb079598eb0abc5a71d27d798
commit dcf362b03f60fadfb079598eb0abc5a71d27d798
Author: Dave Andreoli <d...@gurumeditation.it>
Date: Mon Dec 6 09:26:49 2021 +0100
Update README
---
README.md | 39 ++++++++++++++++++++++++++++++---------
1 file changed, 30 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 93f3aec..bfb96f0 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,33 @@
-# Python bindings for EFL
+# Python bindings for the EFL
+EFL, or the *Enlightenment Foundation Libraries*, is a collection of libraries
for handling many common tasks such as data structures, communication,
rendering, widgets and more. Read more on the [efl web
site](https://www.enlightenment.org/about-efl).
+
+Python-EFL are the python bindings for the whole EFL stack (evas, ecore, edje,
emotion, ethumb and elementary). You can use Python-EFL to build a portable GUI
application in minutes.
+
+The documentation for Python-EFL is available
[here](https://docs.enlightenment.org/python-efl/current/).
+
+## Install from pypi
+
+The last stable release is always available on pypi, and pip is the
raccomanded way to install Python-EFL:
+```
+pip install python-efl
+```
+The only requirement is to have the EFL already installed on your machine, see
[here](https://www.enlightenment.org/docs/distros/start) for install
instructions for various linux distro or for building EFL from sources.
+
+NOTE: Currently only sources packages are available on pip, this means that
the installation will be quite long as it need to compile all the modules, and
that you need a C compiler for installation to work (we highly suggest to use
clang as your C compiler). For the next release we have plans to also upload
binary packages on pypi, so the installation will be blazing fast and will have
zero dependencies!
+
+
+## Install from released tarballs
-## Stable releases
All the stable releases of python-efl can always be found at:
http://download.enlightenment.org/rel/bindings/python/
-To install unpack the tarball and run:
+To install download and unpack a tarball and run:
```
python setup.py build
-sudo python setup.py install
+python setup.py install --user
+or
+sudo python setup.py install (for sistem-wide installation)
```
NOTE: due to strange cython+gcc behaviour we highly suggest to build
python-efl using clang. If you experience issues using gcc (like memory
exhausted or strange compile errors) just use clang in this way:
@@ -18,13 +37,15 @@ CC=clang python setup.py build
```
## Source repository
-Development take place on **git**, in the **master** branch, while we backport
bugfixes in the release branches.
-You will find a branch for each released version, branches are named as
**python-efl-X.X**.
+
+If you would like to contribute to Python-EFL and make changes to the
Python-EFL code you need to build from **git**. Development take place in the
**master** branch, while we backport bugfixes in the release branches. You will
find a branch for each released version, branches are named as
**python-efl-X.X**.
+
+To build from git you also need to have [Cython](https://cython.org/)
installed.
### Main repository
https://git.enlightenment.org/bindings/python/python-efl.git/
-### Secondary repository
+### GitHub repository
https://github.com/DaveMDS/python-efl
The GitHub repo has been created to simplify the workflow for people that do
@@ -34,12 +55,12 @@ Feel free to make pull requests on GitHub.
## Documentation
-Documentation for the last stable release can be found at
[here](https://docs.enlightenment.org/python-efl/current/).
+Documentation for the last stable release can be found
[here](https://docs.enlightenment.org/python-efl/current/).
Additionally you can generate the documentation yourself from the source code
using the following command:
```
python setup.py build build_doc
```
-
+The HTML generated documentation will be available in the folder:
`build/sphinx/html/`
## Some of the projects using Python-EFL (in random order)
--
