Update README.md

Updated Files Organization diagram to reflect current state Title case for titles and headings (important words capitalized) Contributors section added.
2024-03-28 09:14:07 -04:00 · 2024-03-28 09:14:07 -04:00 · 9aae31d7ed
commit 9aae31d7ed
--- a/README.md
+++ b/README.md
@ -1,16 +1,16 @@

-<center> 
+<center>

 ![BlenderCAM](documentation/images/logo.png)

- - - 
+- - -


-### An open source solution for artistic or industrial CAM with Blender 3D
+### An Open Source Solution for Artistic or Industrial 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 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)
@ -20,31 +20,31 @@

 <br>

-[About](#About) • [How to use](#-how-to-use-wiki) • [Features](#-features) • [Post-Processors](#-post-processors) • [Files](#-files-organisation) • [Contributing](#-contributing) • [License](#-disclaimer) 
+[About](#About) • [How to Use](#-how-to-use-wiki) • [Features](#-features) • [Post-Processors](#-post-processors) • [Files](#-files-organisation) • [Contributing](#-contributing) • [License](#-disclaimer)

 <br>

-![Blendercam](documentation/images/suzanne.gif)
+![BlenderCAM](documentation/images/suzanne.gif)


 </center>

 ## 👁️ About
-Blender CAM is an open source solution for artistic, personal, commercial or industrial CAM - Computer aided machining - a g-code generation tool.
+BlenderCAM is an add-on for the free open-source [Blender 3D package](https://www.blender.org/).

-Blender CAM is an add-on for the free open-source [Blender 3d package](https://www.blender.org/).
+It offers an open source solution for artistic, personal, commercial or industrial CAM _(Computer Aided Machining)_,  a G-Code generation tool.

 It has been used for many milling projects, and is actively developed. If you are a developer who would like to help, don't hesitate to fork the project and start generating pull requests.

-## 👨‍🎓 How to use (Wiki)
+## 👨‍🎓 How to Use (Wiki)

-![Linux](https://img.shields.io/badge/Plateform-Linux%20|%20Windows-brightgreen.svg)
+![Linux](https://img.shields.io/badge/Platform-Linux%20|%20Windows-brightgreen.svg)

-Blendercam works on Windows or Linux. Probably on MacOS also.
+BlenderCAM works on Windows or Linux. Probably on MacOS also.

-* [BlenderCam Installation](documentation/Blendercam%20Installation.md) 
-* [Getting started](documentation/Getting%20started.md)
-* [Panel descriptions](documentation/Blendercam-Panel-Descriptions.md)
+* [BlenderCAM Installation](documentation/Blendercam%20Installation.md)
+* [Getting Started](documentation/Getting%20started.md)
+* [Panel Descriptions](documentation/Blendercam-Panel-Descriptions.md)
 * [Tools](documentation/Blendercam-Tools.md)
 * [Example of using Profile and Pocket operations](documentation/Profile%20and%20Pocket%20operations.md)

@ -53,23 +53,23 @@ Blendercam works on Windows or Linux. Probably on MacOS also.

 |                            | Blender from 2.80 to 4.0.0
 | -------------------------- | :----------------: |
-| Several milling strategies for 2D and 3D          |         ✔️        | 
-| Cutter types: ball, ballcone, endmill 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        |         ✔️         |  
-| Arc retract   |         ✔️         |  
-| Pack curves and slice model   |         ✔️         |  
-| Automatic bridges for cutout operation   |         ✔️         |  
-| Chain export and simulation  |         ✔️         |   
+| Several Milling Strategies for 2D and 3D          |         ✔️        |
+| Cutter Types: Ball, Ballcone, Endmill Flat, V-Carve _(various angles)_, User Defined             |         ✔️         |  
+| 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        |         ✔️         |  
+| Arc Retract   |         ✔️         |  
+| Pack Curves and Slice Model   |         ✔️         |  
+| Automatic Bridges for Cutout Operation   |         ✔️         |  
+| Chain Export and Simulation  |         ✔️         |   

-### Pending features
-* Helix entry and ramp down are experimental. 
+### Pending Features
+* Helix entry and ramp down are experimental.
 * 4 and 5 axis milling are only manual


@ -77,7 +77,7 @@ Blendercam works on Windows or Linux. Probably on MacOS also.
 * GRBL
 * Iso
 * LinuxCNC - EMC2
-* Fadal 
+* Fadal
 * Heidenhain
 * Sieg KX1
 * Hafco HM-50
@ -90,24 +90,25 @@ Blendercam works on Windows or Linux. Probably on MacOS also.
 * ...


-## 📒 Files organisation
+## 📒 Files Organisation

 ```
 .
-├── config                     
+├── config
+├── documentation
+├── Examples
 ├── scripts
-│   ├── addons
-│   │   ├── cam
-│   │   │   ├── nc
-│   │   │   └── opencamlib
-│   │   ├── GPack
-│   │   └── print_3d
-│   │       ├── ini
-│   │       └── machine_profiles
-│   └── presets
-│       ├── cam_cutters
-│       ├── cam_machines
-│       └── cam_operations
+│   └── addons
+│       └── cam
+│           ├── nc
+│           ├── opencamlib
+│           ├── presets
+│           |   ├── cam_cutters
+│           |   ├── cam_machines
+│           |   └── cam_operations
+|           ├── tests
+|           |   └── test_data
+|           └── ui_panels
 └── static

 ```
@ -119,7 +120,13 @@ 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

-If you need help or want  to discuss about BlenderCam you can join the [Chat Room #BlenderCam:matrix.org on Matrix](https://riot.im/app/#/room/#blendercam:matrix.org). 
+If you need help or want to discuss about BlenderCAM you can join the [Chat Room #BlenderCAM:matrix.org on Matrix](https://riot.im/app/#/room/#blendercam:matrix.org).
+
+### Contributors
+<a href="https://github.com/pppalain/blendercam/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=pppalain/blendercam" />
+</a>
+

 ## 🤕 DISCLAIMER

@ -133,7 +140,3 @@ 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.
-
-
-
-