From c3055ac2c9291c13b95f7cb941757ed18f32975a Mon Sep 17 00:00:00 2001
From: themancalledjakob <jrkb@jrkb.land>
Date: Thu, 21 Nov 2024 14:44:51 +0100
Subject: [PATCH] update doc

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

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..f67ccf4
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,47 @@
+```
+    _    ____   ____ _____ ____
+   / \  | __ ) / ___|___ /|  _ \
+  / _ \ |  _ \| |     |_ \| | | |
+ / ___ \| |_) | |___ ___) | |_| |
+/_/   \_\____/ \____|____/|____/
+```
+
+Convenience tool to work with 3D typography in Blender and Cinema4D.
+
+# get bpy python working by:
+```bash
+$HOME/git/tools/blender_git/build_linux_v4.1/bin/4.1/python/bin/python3.11 -m venv venv
+source venv/bin/activate
+pip install bpy
+```
+
+to install mathutils, this was necessary for me:
+```
+sudo xbps-install -Sy python3.11-devel
+CFLAGS=$(python3.11-config --cflags) LDFLAGS=$(python3.11-config --ldflags) pip install mathutils
+```
+
+# install addon:
+```bash
+cd <root directory>
+ln -s $(pwd) $HOME/git/tools/blender_git/build_linux_v4.1/bin/4.1/scripts/addons/abc3d
+```
+
+# get blender addon path:
+```python
+bpy.utils.script_paths()
+```
+then check it for the `addons` directory
+
+# addons dir:
+```
+~/git/tools/blender_git/build_linux_v4.1/bin/4.1/scripts/addons/
+```
+
+# addon data:
+```
+~/.config/blender/4.1/datafiles
+```
+
+# reload addon in blender:
+F3 -> "reload scripts"
diff --git a/README.md b/README.md
index 451ac98..9b5d420 100644
--- a/README.md
+++ b/README.md
@@ -8,42 +8,6 @@
 
 Convenience tool to work with 3D typography in Blender and Cinema4D.
 
-The readme is at the moment for development only. Install as you would normally install an addon.
+Install as you would normally install an addon.
 
-# get bpy python working by:
-```bash
-$HOME/git/tools/blender_git/build_linux_v4.1/bin/4.1/python/bin/python3.11 -m venv venv
-source venv/bin/activate
-pip install bpy
-```
-
-to install mathutils, this was necessary for me:
-```
-sudo xbps-install -Sy python3.11-devel
-CFLAGS=$(python3.11-config --cflags) LDFLAGS=$(python3.11-config --ldflags) pip install mathutils
-```
-
-# install addon:
-```bash
-cd <root directory>
-ln -s $(pwd) $HOME/git/tools/blender_git/build_linux_v4.1/bin/4.1/scripts/addons/abc3d
-```
-
-# get blender addon path:
-```python
-bpy.utils.script_paths()
-```
-then check it for the `addons` directory
-
-# addons dir:
-```
-~/git/tools/blender_git/build_linux_v4.1/bin/4.1/scripts/addons/
-```
-
-# addon data:
-```
-~/.config/blender/4.1/datafiles
-```
-
-# reload addon in blender:
-F3 -> "reload scripts"
+Instructions for development in [CONTRIBUTING,md](./CONTRIBUTING.md).
-- 
2.30.2