diff --git a/scripts/addons/docs/fun.md b/scripts/addons/docs/fun.md deleted file mode 100644 index b57fc2fe..00000000 --- a/scripts/addons/docs/fun.md +++ /dev/null @@ -1,5 +0,0 @@ -# Fun - -_so much fun_ - -__SOOOOOOOO MUCH FUN__ \ No newline at end of file diff --git a/scripts/addons/docs/index.rst b/scripts/addons/docs/index.rst index f1f28085..319db3cf 100644 --- a/scripts/addons/docs/index.rst +++ b/scripts/addons/docs/index.rst @@ -7,9 +7,7 @@ Welcome to Fabex's Documentation! ========================================== This site serves as an introduction to Fabex, a free and open source extension for Blender, the free and open-source 3D app. - Fabex allows you to generate toolpaths and gcode files based on 3D objects or 2D Images within Blender. - These files can then be sent to a CNC machine to cut your designs! User Guide @@ -18,11 +16,11 @@ User Guide .. toctree:: :maxdepth: 1 - fun + install This section is for new users, containing basic info on how to install and use the extension. -:doc:`fun` is fun +:doc:`install` contains Installation instructions. Developer Guide ****************** diff --git a/scripts/addons/docs/install.md b/scripts/addons/docs/install.md new file mode 100644 index 00000000..e42a2058 --- /dev/null +++ b/scripts/addons/docs/install.md @@ -0,0 +1,25 @@ +# How to install CNC CAM extension for Blender ? + +## Use CNC CAM extension for Blender from github + +Using CNC CAM Blender extention from github is a great way to try out the newest features and fixes. The latest build (dailybuild) of Blender can be used with the latest Master branch of CNC CAM extension and then you can live on the bleeding edge. + +* [1. Obtaining Blender](#obtaining-blender) +* [2. Install (or update) Blendercam addon](#install-or-update-blendercam-addon) + +## Obtaining Blender +CNC CAM is an extension for Blender. It works now with Blender version 4.21 . + +You can download blender from here: +https://www.blender.org/download/ + +To install CNC CAM extension for Blender, download blendercam.zip + +stable: https://github.com/vilemduha/blendercam/releases + +experimental: https://github.com/pppalain/blendercam/releases + +*don't* extract it. In blender, go to preferences, Get Extension, and select 'Install from Disk' and select the blendercam.zip file you downloaded. After Blender must be restarted to ensure the wheels are correctly installed. + +![image](https://github.com/user-attachments/assets/7776b3dd-2411-4348-b4d7-b0262f683f90) +![image](https://github.com/user-attachments/assets/1bec6168-5b57-48c4-afe7-310664fa979d)