From be701732d23aaa4cb4db06a17b86858478975332 Mon Sep 17 00:00:00 2001
From: George Hotz <geohot@gmail.com>
Date: Sat, 25 Nov 2023 16:33:32 -0800
Subject: [PATCH] a pretty readme so that people trust us

---
 .github/workflows/test.yml |  2 +-
 README                     | 17 -----------------
 README.md                  | 25 +++++++++++++++++++++++++
 3 files changed, 26 insertions(+), 18 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 34c818d..6539e2c 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -65,7 +65,7 @@ jobs:
       - name: Install gpuctypes
         run: pip install .
       - name: Test gpuctypes import
-        run: python3 -c "import gpuctypes.${{ matrix.task }}"
+        run: python3 -c "import gpuctypes.${{ matrix.task }} as ${{ matrix.task }}"
       - uses: actions/upload-artifact@v3
         with:
           name: Generated ${{ matrix.task }} Header
diff --git a/README b/README
deleted file mode 100644
index 6cf10b8..0000000
--- a/README
+++ /dev/null
@@ -1,17 +0,0 @@
-Do you wish that there were simple wrappers for GPU libraries in Python?
-Like not pyopencl, pycuda, and (HIP library someday?) here, but just raw access to the APIs?
-That's what gpuctypes does! While high level libraries have their place, the world needs more low level libraries.
-Like gpuctypes. Welcome home.
-
-Install with:
-pip install gpuctypes
-
-Use:
-gpuctypes.hip
-gpuctypes.cuda
-gpuctypes.opencl
-
-Current version is:
-* ROCm 5.7.1
-* CUDA 11.5
-* OpenCL whatever is in Ubuntu 22.04
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..34b78d0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+## gpuctypes (a low level GPU library for Python)
+
+Do you wish that there were simple wrappers for GPU libraries in Python? Like not pyopencl, pycuda, and (HIP library someday?) here, but just raw access to the APIs?
+
+That's what gpuctypes does! While high level libraries have their place, the world needs more low level libraries. Like gpuctypes. Welcome home.
+
+### Installation
+
+```sh
+pip install gpuctypes
+```
+
+### Usage
+
+```py
+import gpuctypes.hip as hip
+import gpuctypes.cuda as cuda
+import gpuctypes.opencl as opencl
+```
+
+### Current versions
+
+* ROCm 5.7.1
+* CUDA 11.5
+* OpenCL whatever is in Ubuntu 22.04