Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
HsiangNianian authored Sep 23, 2024
1 parent 71adebf commit c3a4e6b
Showing 1 changed file with 2 additions and 54 deletions.
56 changes: 2 additions & 54 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,54 +1,2 @@
rysyn
======

Rysyn is a simple Python library for creating and manipulating 2D and 3D
shapes. It is built on top of the `pygame` library, and is designed to be
easy to use and understand.

Rysyn is currently in development and is not yet ready for use in
production. However, it is already being used in a number of personal
projects, and we welcome contributions from the community.

Installation
------------

Rysyn can be installed using pip:

```
pip install rysyn
```

Usage
---------

To use Rysyn, you first need to create a `Window` object:

```python
from rysyn import Window
window = Window()
```

You can then create shapes and add them to the window:

```python
from rysyn import Circle, Rectangle
circle = Circle((100, 100), 50)
rectangle = Rectangle((200, 200), (100, 50))
window.add(circle)
window.add(rectangle)
```

You can also set the background color of the window:

```python
window.background_color = (255, 255, 255)
```

Finally, you can start the window's main loop:

```python
window.run()
```
rysyn-lang
==========

0 comments on commit c3a4e6b

Please sign in to comment.