From af90286d14999e65e713a3b0c83bcb14cc20dd32 Mon Sep 17 00:00:00 2001
From: Harvey Fong <harvey@oomer.org>
Date: Fri, 11 Apr 2025 21:57:04 -0600
Subject: [PATCH]  added usage

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e028d04..01d3698 100644
--- a/README.md
+++ b/README.md
@@ -5,12 +5,40 @@ Command line convertor from [VoxelMax](https://voxelmax.com) .vmax to DiffuseLog
 ![example](resources/example.jpg)
 
 
-# Precompiled binaries
+# Precompiled binaries ( Alpha release )
 [MacOS](https://a4g4.c14.e2-1.dev/vmax2bella/vmax2bella_macuniversal_0.1.zip)
 
 [Windows](https://a4g4.c14.e2-1.dev/vmax2bella/vmax2bella_win_alpha0.1.zip)
 
 
+# Usage
+
+```
+./vmax2bella -h  // show help
+./vmax2bella -i:bear.vmax // convert bear.vmax to bear.bsz using cubes
+./vmax2bella -i:bear.vmax --mode:mesh // convert to bear.bsz using mesh
+./vmax2bella -i:bear.vmax --mode:mesh --bevel // convert to bear.bsz using mesh and bevel shader
+```
+
+VoxelMax features supported
+- metallness converted to Bella metal quickmaterial (not PBR), roughness supported
+- Material 7 is Glass
+- Material 8 is Liquid and is always a mesh
+- 0 roughness is converted to Oren-Nayar diffuse
+- opacity < 255 turns into Glass
+- roughness > 0 converted to Bella Plastic
+- emitter supported
+
+Load **bear.bsz** into [bella_gui](https://bellarender.com/builds) for rendering
+
+- [TODO] convert scene.json camera
+- [TODO] output one .bsz file per chunk timeline for anim
+- [TODO] convert chunk camera for anim
+
+
+
+
+
 # Build
 
 Download SDK for your OS and move **bella_scene_sdk** into your **workdir**. On Windows rename unzipped folder by removing version ie bella_engine_sdk-24.6.0 -> bella_scene_sdk