Skip to content

Commit

Permalink
README: fix formatting for PyPI
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthieuDartiailh committed Sep 18, 2019
1 parent e396a8b commit 71888cf
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ Welcome to Enaml
:target: http://enaml.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/v/enaml.svg
:target: https://pypi.org/project/enaml/
:alt: PyPI version
:target: https://pypi.org/project/enaml/
:alt: PyPI version
.. image:: https://codecov.io/gh/nucleic/enaml/branch/master/graph/badge.svg
:target: https://codecov.io/gh/nucleic/enaml
:alt: Code Coverage Status

Enaml is a programming language and framework for creating professional-quality
user interfaces with minimal effort.
user interfaces with minimal effort.

What you get
============
Expand All @@ -38,7 +38,7 @@ What it can do for you

- Let you rapidly protoype new GUIs interfaces.

+ Intelligently layout your GUI, using symbolic constraints.
+ Intelligently layout your GUI, using symbolic constraints.
+ It automatically adapts for different platforms, different window sizes.
+ Tell the layout engine what your priorities are for layout, without having to count pixels.

Expand All @@ -48,7 +48,7 @@ What it can do for you
+ Clean separation between your model and view, while keeping your controller code simple.

* You can incorporate Python code directly in the view layer.
* As your GUI design evolves, the constraints engine can adapt the layout.
* As your GUI design evolves, the constraints engine can adapt the layout.
* Object-Oriented design allows you to reuse parts of your GUI in other parts of your projects.

- Let you customise a GUI for your particular needs.
Expand All @@ -59,7 +59,7 @@ What it can do for you

Supported Versions
==================
Enaml applications can be run on any platform which supports Python (2.7, 3.4, 3.5 and 3.6) and `Qt <https://doc.qt.io/qt-5/supported-platforms.html>`_ (versions 4 or 5).
Enaml applications can be run on any platform which supports Python (2.7, 3.4, 3.5 and 3.6) and Qt (versions 4 or 5, see https://doc.qt.io/qt-5/supported-platforms.html).

This includes Linux, Windows, macOs, Android and iOS. (Automated testing of Enaml runs on Linux.)

Expand All @@ -73,15 +73,17 @@ Watch some introductory talks about Enaml and what it can do:

.. image:: https://img.youtube.com/vi/ycFEwz_hAxk/2.jpg
:target: https://youtu.be/ycFEwz_hAxk

`S. Chris Colbert (@sccolbert) presents at Enthought 2012. <https://www.youtube.com/watch?v=ycFEwz_hAxk>`_

.. image:: https://img.youtube.com/vi/G5ZYUGL7uTo/1.jpg
:target: https://www.youtube.com/watch?v=G5ZYUGL7uTo

`Tom Stordy-Allison (@tstordyallison) presents at Pycon UK 2016. <https://www.youtube.com/watch?v=G5ZYUGL7uTo>`_

The `Enaml documentation <http://enaml.readthedocs.io/en/latest>`_ includes all the details, including `useful examples <http://enaml.readthedocs.io/en/latest/examples>`_.

You can ask questions on the `Enaml Google Group <http://groups.google.com/d/forum/enaml>`_
You can ask questions on the `Enaml Google Group <http://groups.google.com/d/forum/enaml>`_
or with the `Enaml tag on StackOverflow <https://stackoverflow.com/questions/tagged/enaml>`_.

For version information, see the `release notes <https://github.com/nucleic/enaml/blob/master/releasenotes.rst>`_.
Expand All @@ -96,7 +98,7 @@ The `Employee Tutorial <http://enaml.readthedocs.io/en/latest/examples/tut_emplo

.. image:: http://enaml.readthedocs.io/en/latest/_images/tut_employee_layout.png
:target: http://enaml.readthedocs.io/en/latest/examples/tut_employee.html

Button Ring
~~~~~~~~~~~
The `Button Ring Example <https://enaml.readthedocs.io/en/latest/examples/ex_button_ring.html>`_ goes the other way. The result is neither professional-looking nor easy-to-use, but it shows the power and flexibility of constraints-based layout - it might be silly, but this could not be achieved with typical layout systems.
Expand All @@ -110,5 +112,5 @@ The `Dock Item Alerts Example <https://enaml.readthedocs.io/en/latest/examples/e

.. image:: http://enaml.readthedocs.io/en/latest/_images/ex_dock_item_alerts.png
:target: https://enaml.readthedocs.io/en/latest/examples/ex_dock_item_alerts.html

Check out the `documentation <http://enaml.readthedocs.io/en/latest/examples/index.html>`_ for more examples.

0 comments on commit 71888cf

Please sign in to comment.