diff --git a/README.md b/README.md index 6ab1583..ab98892 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,46 @@ -Blender CAM is an open source solution for artistic CAM - Computer aided machining - a g-code generation tool. +![BlenderCAM](http://github.com/blendercam/blendercam/static/logo.png) +# BlenderCam - CNC path addon + +Blender CAM is an open source solution for artistic CAM - Computer aided machining - a g-code generation tool. Blender CAM is an extension for the free open-source Blender 3d package. -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 contact me. +It has been used for many milling projects, and is actively developed. +If you are a developer who would like to help, fork and open pullrequests -This extension is free of charge, however you can donate to support the development and appreciate the work which has allready been done. -There is currently no warranty for the results from blender CAM - you have to check your paths before use. Blender CAM has been tested with success in my studio. I wouldn't recommend Blender CAM for metalworking now, be carefull if you try it. -Read more and join the forum on: +[![Chat on Matrix ][matrix-badge]](https://riot.im/app/#/room/#blendercam:matrix.org) -http://blendercam.blogspot.fi + +## Installation and Usage + +See the [Wiki](https://github.com/vilemduha/blendercam/wiki). + + +## Resources + +* [Development](https://github.com/blendercam/blendercam) +* [Documentation]https://github.com/vilemduha/blendercam/wiki) +* [Freenode IRC](http://webchat.freenode.net/?channels=%23blendercam) (#blendercam) +* [The Matrix](https://riot.im/app/#/room/#blendercam:matrix.org) (#blendercam:matrix.org) +* [Issue Tracker](https://github.com/blendercam/blendercam/issues) + + +## Dependancies + +* Blender 2.80 +* Python 2.7 & OpenCamLib (optiona) + + +## 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/static/logo.png b/static/logo.png new file mode 100644 index 0000000..9bbd2d2 Binary files /dev/null and b/static/logo.png differ