readme

README.md

@@ -2,18 +2,25 @@
 
 Our version of differentiable gaussian rasterizer
 
-# ref_rast
+# Installation
 
-Copied official version of differentiable gaussian rasterizer
+For CUDA development, it is recommend to install with `BUILD_NO_CUDA=1`, which
+will disable compiling during pip install, and instead use JIT compiling on your
+first run. The benefit of JIT compiling is that it does incremental compiling as
+you modify your cuda code so it is much faster than re-compile through pip. Note
+the JIT compiled library can be found under `~/.cache/torch_extensions/py*-cu*/`.
 
-# Installation
+```
+BUILD_NO_CUDA=1 pip install -e .[dev]
+```
+
+If you won't touch the underlying CUDA code, you can just install with compiling:
 
 ```
-python3 -m pip install --upgrade pip
-cd diff_rast; pip install -e .
-cd ../ref_rast; pip install -e .
+pip install -e .[dev]
 ```
 
+
 # Brief walkthrough
 
 The main python bindings for rasterization are found by importing diff_rast