Skip to content

Commit fb1950f

Browse files
committed
docs about materialshapes
1 parent 9c5f496 commit fb1950f

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,9 @@ pip install kivymd==2.0.0
5151
- [Kivy](https://github.com/kivy/kivy) >= 2.3.0 ([Installation](https://kivy.org/doc/stable/gettingstarted/installation.html))
5252
- [Python 3.7+](https://www.python.org/)
5353
- [Pillow](https://github.com/python-pillow/Pillow/)
54+
- [PyCairo](https://github.com/pygobject/pycairo) ([Installation](https://pycairo.readthedocs.io/en/latest/getting_started.html#getting-started))
5455
- [MaterialColor](https://github.com/T-Dynamos/materialyoucolor-python)
56+
- [MaterialShapes](https://github.com/T-Dynamos/materialshapes-python)
5557
- [asynckivy](https://github.com/asyncgui/asynckivy)
5658

5759
### How to install
@@ -89,6 +91,9 @@ requirements = python3,
8991
kivy,
9092
https://github.com/kivymd/KivyMD/archive/master.zip,
9193
materialyoucolor,
94+
materialshapes,
95+
pycairo,
96+
pillow,
9297
exceptiongroup,
9398
asyncgui,
9499
asynckivy,

docs/sources/getting-started.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,13 @@ Getting Started
44
In order to start using `KivyMD`, you must first `install the Kivy framework <https://kivy.org/doc/stable/gettingstarted/installation.html>`_
55
on your computer. Once you have installed `Kivy`, you can install `KivyMD`.
66

7-
.. warning:: `KivyMD` depends on `Kivy`!
8-
Therefore, before using `KivyMD`, first `learn how to work <https://kivy.org/doc/stable/>`_ with `Kivy`.
7+
.. note::
8+
9+
On **Linux** and **macOS**, you may also need to install `PyCairo <https://pycairo.readthedocs.io/en/latest/getting_started.html#getting-started>`_
10+
manually before installing KivyMD, as it is a required dependency for rendering materialshapes.
11+
12+
On **Windows**, this step is not necessary — ``pip`` will automatically install PyCairo when needed.
13+
914

1015
Installation
1116
------------
@@ -183,4 +188,4 @@ And the equivalent with `KivyMD`
183188
------
184189

185190
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/kivy-ripple-rectangle-button.gif
186-
:align: center
191+
:align: center

0 commit comments

Comments
 (0)