diff --git a/README.md b/README.md index 4920708..ddb4eb9 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Before us, there have been many tutorials and add-ons for importing volumetric d Below are some examples with Bioxel Nodes. Thanks to Cycles Render, the volumetric data can be rendered with great detail: -![gallery](docs/assets/gallery.png) +![cover](docs/assets/cover.png) The "Bioxel" in "Bioxel Nodes", is a combination of the words "Bio-" and "Voxel". Bioxel is a voxel that stores biological data. We are developing a toolkit around Bioxel for better biological data visualization. but before its release, we made this Blender version of bioxels toolkit first, in order to let more people to have fun with volumetric data. [Getting Started](https://omoolab.github.io/BioxelNodes/latest/getting-started) diff --git a/docs/assets/cover.png b/docs/assets/cover.png new file mode 100644 index 0000000..3d99b2e Binary files /dev/null and b/docs/assets/cover.png differ diff --git a/docs/getting-started.md b/docs/getting-started.md index cc0a271..5f2f4a4 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -4,8 +4,19 @@ Currently only support Blender 4.0 or above, make sure you have the correct vers ## Add-on Installation -Download the latest version https://github.com/OmooLab/BioxelNodes/releases/latest -In Blender, Edit > Preferences > Add-ons > Install, select the `BioxelNodes_{version}.zip` you just downloaded. +#### For Blender 4.2 or higher + +Download the **Extension** version `BioxelNodes_Extension_{version}.zip` from https://github.com/OmooLab/BioxelNodes/releases/latest +In Blender, Edit > Preferences > Extensions > Install from Disk, select the zip file you just downloaded. + +Thats it! + +> If it cannot be enable, just reboot blender. + +#### For Blender 4.0 or 4.1 + +Download the **Addon** version `BioxelNodes_Addon_{version}.zip` from https://github.com/OmooLab/BioxelNodes/releases/latest +In Blender, Edit > Preferences > Add-ons > Install, select the zip file you just downloaded. The add-on requires a third-party python dependency called SimpleITK, click `Install SimpleITK` button below to install the dependency. After clicking, blender may get stuck, it is downloading and installing, just wait for a moment. After that, click `Reboot Blender` button. diff --git a/docs/index.md b/docs/index.md index a54bfff..8b15d62 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ Before us, there have been many tutorials and add-ons for importing volumetric d Below are some examples with Bioxel Nodes. Thanks to Cycles Render, the volumetric data can be rendered with great detail: -![gallery](assets/gallery.png) +![cover](assets/cover.png) The "Bioxel" in "Bioxel Nodes", is a combination of the words "Bio-" and "Voxel". Bioxel is a voxel that stores biological data. We are developing a toolkit around Bioxel for better biological data visualization. but before its release, we made this Blender version of bioxels toolkit first, in order to let more people to have fun with volumetric data. [Getting Started](https://omoolab.github.io/BioxelNodes/latest/getting-started) diff --git a/mkdocs.yml b/mkdocs.yml index 7e89023..24e9ad3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,11 +8,11 @@ repo_url: https://github.com/OmooLab/BioxelNodes nav: - BioxelNodes: - - index.md - - Getting Started: getting-started.md - - Features & Options: features.md - - Nodes: nodes.md - - Future Features: misc.md + - index.md + - Getting Started: getting-started.md + - Features & Options: features.md + - Nodes: nodes.md + - Future Features: misc.md theme: name: material @@ -57,6 +57,7 @@ theme: extra: version: provider: mike + default: latest extra_css: - stylesheets/extra.css