Skip to content

Commit 6792eb0

Browse files
committed
PyPI deserves a minimal README.
1 parent 1d22ea7 commit 6792eb0

File tree

1 file changed

+26
-10
lines changed

1 file changed

+26
-10
lines changed

README.rst

+26-10
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,45 @@ Python A-Turtle: AsyncIO-ready Turtle Graphics
33

44
Python A-Trutle is a library that implements Turtle Graphics with `asyncio` support.
55

6-
.. todo::
6+
A short capability summary:
77

8-
Complete welcome text.
8+
* Supports both sync and asyncio compatible coroutine API.
9+
* Multiple turtle support with either vector or bitmap shapes.
10+
* Concurrent animation support via the coroutine API.
11+
* Built on top of the Standard Library's ``tkinter`` module.
12+
* Sprite support (essentially turtles that don't draw lines)
13+
* More.
914

1015

1116
Installation
1217
------------
1318

14-
.. todo::
19+
Python A-Turtle is a pure Python package distributed via `PyPI <https://pypi.org/pypi/aturtle>`_. Install it with:
20+
21+
.. code-block:: console
22+
23+
$ pip install aturtle
24+
25+
For improved bitmap image rotation speed and quality, install the optional `Pillow <https://pypi.org/pypi/Pillow>`_ extra with:
26+
27+
.. code-block:: console
28+
29+
$ pip install aturtle[pillow]
1530
16-
Write installation section.
1731
1832
1933
Quick Start
2034
-----------
2135

22-
.. todo::
36+
.. code-block:: python
2337
24-
Write quick start section.
38+
import aturtle
39+
40+
w = aturtle.Window()
41+
sh = aturtle.shapes.vector.Triangle(radius=20, angle=0)
42+
s = aturtle.create_sprite(w, sh, update=True)
43+
t = aturtle.turtle.Turtle(s)
44+
t.sync_forward(100)
2545
2646
2747
Thanks
@@ -44,10 +64,6 @@ About
4464

4565
.. marker-start-about-dont-remove
4666
47-
.. todo::
48-
49-
Review sentence tense.
50-
5167
Python A-Turtle is being created by Tiago Montes.
5268

5369
.. marker-end-about-dont-remove

0 commit comments

Comments
 (0)