v0.2.0

CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing to mlx-examples
+
+We want to make contributing to this project as easy and transparent as
+possible.
+
+## Pull Requests
+
+1. Fork and submit pull requests to the repo.
+2. If you've added code that should be tested, add tests.
+3. Every PR should have passing tests and at least one review.
+4. For code formatting install `pre-commit` using something like `pip install pre-commit` and run `pre-commit install`.
+   This should install hooks for running `black` and `clang-format` to ensure
+   consistent style for C++ and python code.
+
+   You can also run the formatters manually as follows on individual files:
+
+     ```bash
+     clang-format -i file.cpp
+     ```
+
+     ```bash
+     black file.py
+     ```
+
+     or,
+
+     ```bash
+     # single file
+     pre-commit run --files file1.py 
+
+     # specific files
+     pre-commit run --files file1.py file2.py
+     ```
+
+   or run `pre-commit run --all-files` to check all files in the repo.
+
+## Issues
+
+I use GitHub issues to track public bugs. Please ensure your description is
+clear and has sufficient instructions to be able to reproduce the issue.
+
+## License
+
+By contributing to mlx-kan, you agree that your contributions will be licensed
+under the LICENSE file in the root directory of this source tree.

README.md

@@ -335,7 +335,7 @@ The mlx-kan software suite was developed by Gökdeniz Gülmez. If you find
 mlx-kan useful in your research and wish to cite it, please use the following
 BibTex entry:
 
-```
+```text
 @software{
   mlx-kan,
   author = {Gökdeniz Gülmez},
@@ -344,4 +344,4 @@ BibTex entry:
   version = {0.1.9},
   year = {2024},
 }
-```
+```