diff --git a/documentation/Blendercam-Panel-Descriptions.md b/documentation/Blendercam-Panel-Descriptions.md index 1dc7b948..2d87e524 100644 --- a/documentation/Blendercam-Panel-Descriptions.md +++ b/documentation/Blendercam-Panel-Descriptions.md @@ -37,7 +37,7 @@ First of all, change render engine to CAM to use the blender cam tool. * **Operation name** - Select this field to change the name of the currently selected operation. -* **File name** - Name of the gcode file. The file extension used will be determined by the g-code post processor selected. See [Cam Machine panel](#cam-machine-panel) for setting post processor. +* **File name** - Name of the gcode file. The file extension used will be determined by the g-code post processor selected. See [Cam Machine panel](Blendercam-Panel-Descriptions.md) for setting post processor. * **Auto export** - If enabled, the g-code will be automatically generate and saved to the file after the computation of the operation, in the same folder where you saved the project or blend file. diff --git a/documentation/Getting started.md b/documentation/Getting started.md index 8c345887..ab75427d 100644 --- a/documentation/Getting started.md +++ b/documentation/Getting started.md @@ -1,4 +1,4 @@ -This is a step-by-step tutorial on generating a toolpath with Blender CAM. For detailed description of panel options go [here](Blendercam-Panel-Descriptions). +This is a step-by-step tutorial on generating a toolpath with Blender CAM. For detailed description of panel options go [here](Blendercam-Panel-Descriptions.md). @@ -25,7 +25,7 @@ Setup machine parameters (postprocessor, maximum feed rate, work area, etc.) in Add new operation in the render properties. ![New operation](images/newop.png) -Choose Parallel (or Outline Fill, Circles, Spiral, Block, Cross) in the Strategy dialog. Waterline option works best when [OpenCAMLib](Using-BlenderCAM-with-OpenCAMLib) is installed and other operations require curve data source. See how to generate curves from mesh model [here](Machining-technical-parts-using-Profile-and-Pocket-operations). +Choose Parallel (or Outline Fill, Circles, Spiral, Block, Cross) in the Strategy dialog. Waterline option works best when [OpenCAMLib](Opencamlib%20Installation.md) is installed and other operations require curve data source. See how to generate curves from mesh model [here](Profile%20and%20Pocket%20operations.md). ![Select operation](images/selectOperation.png) @@ -51,7 +51,7 @@ Set "Distance between toolpaths" to desired value. "Distance along toolpaths" option determines accuracy. Lower values result in more accurate toolpath, but make computation slower and increase amount of resulting G-code. -Select "Use exact mode" - it improves accuracy. If you have [OpenCAMLib](Using-BlenderCAM-with-OpenCAMLib) installed, also select "UseOpenCAMLib" - it impoves accuracy and speeds up the computing time. OpenCAMLib also enables high quality algorithm from calculating waterline toolpaths. +Select "Use exact mode" - it improves accuracy. If you have [OpenCAMLib](Opencamlib%20Installation.md) installed, also select "UseOpenCAMLib" - it impoves accuracy and speeds up the computing time. OpenCAMLib also enables high quality algorithm from calculating waterline toolpaths. CAM Movement: diff --git a/documentation/Home.md b/documentation/Home.md deleted file mode 100644 index f92e406e..00000000 --- a/documentation/Home.md +++ /dev/null @@ -1,142 +0,0 @@ - -
- -![BlenderCAM](images/logo.png) - -- - - - - -### An open source solution for artistic CAM with Blender 3D - -

- -[![Chat on Matrix](https://img.shields.io/matrix/blendercam:matrix.org?label=Chat%20on%20Matrix)](https://riot.im/app/#/room/#blendercam:matrix.org) -[![Chat on Freenode](https://img.shields.io/badge/chat-on%20freenode-brightgreen.svg)](http://webchat.freenode.net/?channels=%23blendercam) -[![Chat on Freenode](https://img.shields.io/github/issues/vilemduha/blendercam)](https://github.com/vilemduha/blendercam) -![Last commit](https://img.shields.io/github/last-commit/vilemduha/blendercam) -![Contributors](https://img.shields.io/github/contributors/vilemduha/blendercam) -![Size](https://img.shields.io/github/repo-size/vilemduha/blendercam) -![License](https://img.shields.io/github/license/vilemduha/blendercam) - -

-
-

- -[About](#About) • [How to use](#How-to-use-(Wiki)) • [Features](#Features) • [Post-Processors](#Post-processors) • [Contributing](#Contributing) • [License](#Disclaimer) -

- -
- -![Blendercam](images/suzanne.png) - - -
- -## 👁️ About -Blender CAM is an open source solution for artistic CAM - Computer aided machining - a g-code generation tool. - -Blender CAM is an add-on for the free open-source [Blender 3d package](https://www.blender.org/). - -It has been used for many milling projects, and is actively developed. If you are a developer who would like to help, don't hesistate to fork the project and start generating pull requests. - -## 👨‍🎓 How to use (Wiki) - -![Linux](https://img.shields.io/badge/Plateform-Linux%20|%20Windows-brightgreen.svg) - -BlenderCam is recommended with Linux. BlenderCam can work on Windows but the installation of a dependency (OpenCamlib) is tricky. - -* [BlenderCam Installation](./Blendercam_installation.md) -* [Getting started](./Getting_started.md) -* [Panel descriptions](./Blendercam-Panel-Descriptions.md) -* [Tools](./Blendercam-Tools.md) -* [Example of using Profile and Pocket operations](./Profile_and_Pocket_operations.md) - - -## 👌 Features - -| | Blender 2.92 and 2.80 -| -------------------------- | :----------------: | -| Several milling strategies for 2D and 3D | ✔️ | -| Cutter types: ball, flat, v-carve with various angles, user definable | ✔️ | -| work with 3d data or depth images | ✔️ | -| Layers and skin for roughing. | ✔️ | -| Inverse milling | ✔️ | -| Various options for ambient around model | ✔️ | -| protection of vertical surfaces | ✔️ | -| Stay low - option for movement | ✔️ | -| Material size setup | ✔️ | -| Simulation of 3d operations | ✔️ | -| Helix entry, arc retract, ramp down for some of the strategies. | ✔️ | -| Automatic bridges for cutout operation | ✔️ | -| Chain export and simulation | ✔️ | -| Background computing of the operations, so you can continue working | ✔️ | - - - -## 💻 Post-processors -* GRBL -* Iso -* LinuxCNC - EMC2 -* Fadal -* Heidenhain -* Sieg KX1 -* Hafco HM-50 -* Centroïd M40 -* Anilam Crusader M -* Gravos -* WinPC-NC -* ShopBot MTC -* Lynx Otter o -* ... - - -## 🔬 Pending features -* motion direction - classic, conventional, meander, are only partially supported -* 4 and 5 axis milling - -## 📒 Files organisation - -``` -. -├── config -├── scripts -│   ├── addons -│   │   ├── cam -│   │   │   ├── nc -│   │   │   └── opencamlib -│   │   ├── GPack -│   │   └── print_3d -│   │   ├── ini -│   │   └── machine_profiles -│   └── presets -│   ├── cam_cutters -│   ├── cam_machines -│   └── cam_operations -└── static - -``` - - - -## 🤝 Contributing -BlenderCAM has been used for many milling projects, and is actively developed. - -If you are a developer who would like to help, fork and open pull requests - - -## 🤕 DISCLAIMER - -THE AUTHORS OF THIS SOFTWARE ACCEPT ABSOLUTELY NO LIABILITY FOR -ANY HARM OR LOSS RESULTING FROM ITS USE. IT IS _EXTREMELY_ UNWISE -TO RELY ON SOFTWARE ALONE FOR SAFETY. Any machinery capable of -harming persons must have provisions for completely removing power -from all motors, etc, before persons enter any danger area. All -machinery must be designed to comply with local and national safety -codes, and the authors of this software can not, and do not, take -any responsibility for such compliance. - -This software is released under the GPLv2. - - - - diff --git a/documentation/Opencamlib Installation.md b/documentation/Opencamlib Installation.md index 65598d51..69b3f130 100644 --- a/documentation/Opencamlib Installation.md +++ b/documentation/Opencamlib Installation.md @@ -1,25 +1,14 @@ # Installation ## Obtaining Blender -Download portable version for linux64 2.83 or 2.92 -from a command line as user to download and extract blender +You have to install Blender before as descripted [here](Blendercam%20Installation.md). + +--- -``` -$ cd ~/ -$ mkdir Apps -$ cd Apps -$ wget https://ftp.nluug.nl/pub/graphics/blender/release/Blender2.92/blender-2.92.0-linux64.tar.xz -$ tar xf blender-2.92.0-linux64.tar.xz -$ cd blender-2.92.0-linux64/2.92/python/bin -$ ./python3.7m -m ensurepip -$ ./pip3 install shapely -$ ./pip3 install vtk -$ ./pip3 install Equation -``` ## Obtaining OpenCamLib -installing python and libboost-python headers +Installing python and libboost-python headers ``` @@ -60,7 +49,7 @@ the python 3 version may depend on your system ## Installing OpenCamLib in Blender -now we need to link some files to the blender python3.7 interpreter +Now we need to link some files to the blender python3.7 interpreter Depending on your base system python files may be in other place @@ -101,8 +90,6 @@ $ ln -s /home/blendercam/projects/opencamlib/src/lib/procmemory.py ~/Apps/blende $ ln -s /home/blendercam/projects/opencamlib/src/lib/camvtk.py ~/Apps/blender-2.92.0-linux64/2.92/python/lib/python3.7/site-packages/ $ ln -s /home/blendercam/projects/opencamlib/src/lib/pyocl.py ~/Apps/blender-2.92.0-linux64/2.92/python/lib/python3.7/site-packages/ ``` -## next steps can be found in this link -https://github.com/vilemduha/blendercam/wiki/Using-Blendercam-from-github ## Tips ### OpenSuSE 15.1