Skip to content

Commit cd3aa56

Browse files
committed
Python README
1 parent 0c461f7 commit cd3aa56

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

gomori-py/README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# gomori-py
22

3+
Python wrapper around the [Rust gomori library](../gomori).
4+
5+
> [!IMPORTANT]
6+
> This is work in progress.
7+
38
## Setup
49

510
You'll probably want to use a virtualenv for the following steps. You can either use a pre-built wheel or build it from source yourself.
@@ -24,4 +29,4 @@ maturin develop
2429

2530
After setup is completed, you can just `from gomori import *`.
2631

27-
The API is pretty much the same as in Rust, so check out the documentation in that package.
32+
The API is pretty much the same as in Rust, so check out the documentation for that package.

0 commit comments

Comments
 (0)