From 04fedca0bfcf68dfdcf7474d1b7513bbe8dc9f22 Mon Sep 17 00:00:00 2001
From: minghuaw <michael.wu1107@gmail.com>
Date: Tue, 16 Apr 2024 17:32:27 -0700
Subject: [PATCH] added CONTRIBUTING.md

---
 CONTRIBUTING.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 README.md       |  4 ----
 2 files changed, 47 insertions(+), 4 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..9d472fd87
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,47 @@
+# `mlx-rs` Contributing Guide
+
+## Orgnaization
+
+### Branches
+
+- `main` is the default branch
+- `dev` contains the latest development changes
+
+### Directories
+
+| Directory | Description |
+| --- | --- |
+| `mlx-sys` | Raw FFI bindings to the `mlx` framework |
+| examples | TODO: add examples |
+
+## Developer Guide
+
+### Pre-requisites
+
+1. An Apple silicon Mac
+2. Xcode >= 15.0
+3. macOS SDK >= 14.0
+4. A C++ compiler with C++17 support
+5. `cmake` version 3.24 or later and `make`
+6. [rust](https://www.rust-lang.org/)
+
+### Building and Testing
+
+1. Clone the repository
+
+    ```sh
+    git clone https://github.com/oxideai/mlx-rs.git
+    cd mlx-rs && git submodule update --init
+    ```
+
+2. Build the project
+
+    ```sh
+    cargo build
+    ```
+
+3. Run the tests
+
+    ```sh
+    cargo test --all
+    ```
diff --git a/README.md b/README.md
index 348056e69..4669cda27 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,3 @@
 # mlx-rs (WIP)
 
 Rust bindings to Apple's mlx framework
-
-## DO NOT USE YET
-
-Recent work can be found in the "v0.1.0-dev" branch