Merge pull request #4 from instadeepai/docs/add-citation

docs: add citation
instadeepai · Dec 14, 2023 · 9c96101 · 9c96101
2 parents 8d4c8d5 + fded6f6
commit 9c96101
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -3,4 +3,4 @@ include requirements/*
 recursive-include * *.npy
 
 # remove the test specific files
-recursive-exclude * *_test.py
+recursive-exclude * *_test.py
diff --git a/README.md b/README.md
@@ -93,6 +93,20 @@ For each environment, a version suffix is appended, e.g. `EnvironmentName-v1`.
 When changes are made to environments that might impact learning results,
 the version number is incremented by one to prevent potential confusion.
 
+## Citing Matrax 📝
+
+If you use any of the environment implementations in Matrax please consider citing this library.
+
+```
+@software{matrax2023github,
+  author = {Arnu Pretorius},
+  title = {Matrax: Matrix Games in JAX},
+  url = {http://github.com/instadeepai/matrax},
+  version = {v0.0.4-alpha},
+  year = {2023},
+}
+```
+
 ## See Also 🔎
 
 Other works have embraced the approach of writing RL environments in JAX.