summaryrefslogtreecommitdiffstats
path: root/graphics/mitsuba2/README
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/mitsuba2/README')
-rw-r--r--graphics/mitsuba2/README31
1 files changed, 31 insertions, 0 deletions
diff --git a/graphics/mitsuba2/README b/graphics/mitsuba2/README
new file mode 100644
index 0000000000..d646cd4980
--- /dev/null
+++ b/graphics/mitsuba2/README
@@ -0,0 +1,31 @@
+mitsuba (computer graphics renderer)
+
+Mitsuba is a 3D rendering engine placing emphasis
+on experimental rendering techniques.
+
+This SlackBuild is based on a Git commit from 8 March 2022.
+It compiles from source code, and installs to /opt with a
+symlink to the `mitsuba` binary in `/usr/bin`
+
+## Documentation
+
+To build docs, you must have Sphinx and assorted Sphinx plugins
+installed. These are available through `pip`:
+
+```
+$ python3 -m pip install sphinx \
+ sphinxcontrib-bibtex \
+ guzzle_sphinx_theme
+```
+
+This SlackBuild doesn't build the docs by default. To enable
+the docs, set the `DOCS` variable to `yes` as you build:
+
+```
+DOCS=yes sh ./mitsuba2.SlackBuild
+```
+
+## See also
+
+There is a Mitsuba Blender plugin available from
+https://github.com/mitsuba-renderer/mitsuba2-blender