aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorNao Pross <np@0hm.ch>2024-03-02 00:47:08 +0100
committerNao Pross <np@0hm.ch>2024-03-02 00:47:08 +0100
commit32a5c57a997794e2cb35d1b74123b4ec15952ef7 (patch)
treefda69cc2cbee6e6e0e10f5c2eb3c959f0ed98775 /README.md
downloadmdpoly-32a5c57a997794e2cb35d1b74123b4ec15952ef7.tar.gz
mdpoly-32a5c57a997794e2cb35d1b74123b4ec15952ef7.zip
Create empty python project
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bddcf1b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# `mdpoly` Multidimensional Polynomials
+
+Work in progress!
+
+## Minimal working example
+
+```python
+import mdpoly as poly
+
+x, y = poly.Variable.from_names("x, y")
+
+p = x + 2 * y + y ** 2
+```