From 1b0dcae2f4784a67ec7f3a0bf10b80545dd98179 Mon Sep 17 00:00:00 2001
From: Solal Nathan <otthorn@crans.org>
Date: Tue, 23 Feb 2021 09:20:50 +0100
Subject: [PATCH] Add documentation

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4cecc27
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# NeRF Tutorial
+
+This example code is largely inspried from the Jupyter Notebook given by 
+https://github.com/facebookresearch/pytorch3d/blob/master/docs/tutorials/fit_simple_neural_radiance_field.ipynb
+
+It has been adapted to be ran inside a python sheel and not a jupyer notebook.
+It is GPU only, there is support for CPU.
+
+It cannot run my lab computer: NVIDIA GeForce RTX 2060 (6GiB of VRAM)
+and thus need to be run on the cluster which has more VRAM.