From cd3aa56b3ec9f5e8543ead4cc137a1347cb54b36 Mon Sep 17 00:00:00 2001 From: nnmm Date: Tue, 23 Jul 2024 19:56:05 +0200 Subject: [PATCH] Python README --- gomori-py/README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/gomori-py/README.md b/gomori-py/README.md index 4949aa4..44275a8 100644 --- a/gomori-py/README.md +++ b/gomori-py/README.md @@ -1,5 +1,10 @@ # gomori-py +Python wrapper around the [Rust gomori library](../gomori). + +> [!IMPORTANT] +> This is work in progress. + ## Setup 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 After setup is completed, you can just `from gomori import *`. -The API is pretty much the same as in Rust, so check out the documentation in that package. \ No newline at end of file +The API is pretty much the same as in Rust, so check out the documentation for that package. \ No newline at end of file