Merge pull request #13006 from ElectronicsArchiver/main

Formatted README

2 files changed, 174 insertions, 64 deletions

diff --git a/README.md b/README.md
index 8ec3101ef6..5ece462f61 100644
--- a/README.md
+++ b/README.md
@@ -1,64 +1,93 @@
-# Cura
-
-<p align="center">
-    <a href="https://github.com/Ultimaker/Cura/actions/workflows/unit-test.yml" alt="Unit Tests">
-        <img src="https://github.com/Ultimaker/Cura/actions/workflows/unit-test.yml/badge.svg" /></a>
-    <a href="https://github.com/Ultimaker/Cura/actions/workflows/conan-package.yml" alt="Unit Tests">
-        <img src="https://github.com/Ultimaker/Cura/actions/workflows/conan-package.yml/badge.svg" /></a>
-    <a href="https://github.com/Ultimaker/Cura/issues" alt="Open Issues">
-        <img src="https://img.shields.io/github/issues/ultimaker/cura" /></a>
-    <a href="https://github.com/Ultimaker/Cura/issues?q=is%3Aissue+is%3Aclosed" alt="Closed Issues">
-        <img src="https://img.shields.io/github/issues-closed/ultimaker/cura?color=g" /></a>
-    <a href="https://github.com/Ultimaker/Cura/pulls" alt="Pull Requests">
-        <img src="https://img.shields.io/github/issues-pr/ultimaker/cura" /></a>
-    <a href="https://github.com/Ultimaker/Cura/graphs/contributors" alt="Contributors">
-        <img src="https://img.shields.io/github/contributors/ultimaker/cura" /></a>
-    <a href="https://github.com/Ultimaker/Cura" alt="Repo Size">
-        <img src="https://img.shields.io/github/repo-size/ultimaker/cura?style=flat" /></a>
-    <a href="https://github.com/Ultimaker/Cura/blob/master/LICENSE" alt="License">
-        <img src="https://img.shields.io/github/license/ultimaker/cura?style=flat" /></a>
-</p>
-
-Ultimaker Cura is a state-of-the-art slicer application to prepare your 3D models for printing with a 3D printer. With hundreds of settings
-and hundreds of community-managed print profiles, Ultimaker Cura is sure to lead your next project to a success.
-
-![Screenshot](cura-logo.PNG)
-
-## Logging Issues
-
-For crashes and similar issues, please attach the following information:
-
-* (On Windows) The log as produced by dxdiag (start -> run -> dxdiag -> save output)
-* The Cura GUI log file, located at
-    * `%APPDATA%\cura\<Cura version>\cura.log` (Windows), or usually `C:\Users\<your username>\AppData\Roaming\cura\<Cura version>\cura.log`
-    * `$HOME/Library/Application Support/cura/<Cura version>/cura.log` (OSX)
-    * `$HOME/.local/share/cura/<Cura version>/cura.log` (Ubuntu/Linux)
-
-If the Cura user interface still starts, you can also reach this directory from the application menu in Help -> Show settings folder.
-An alternative is to install the [ExtensiveSupportLogging plugin](https://marketplace.ultimaker.com/app/cura/plugins/UltimakerPackages/ExtensiveSupportLogging)
-this creates a zip folder of the relevant log files. If you're experiencing performance issues, we might ask you to connect the CPU profiler
-in this plugin and attach the collected data to your support ticket. 
-
-## Running from Source
-Please check our [Wiki page](https://github.com/Ultimaker/Cura/wiki/Running-Cura-from-Source) for details about running Cura from source.
-
-## Plugins
-Please check our [Wiki page](https://github.com/Ultimaker/Cura/wiki/Plugin-Directory) for details about creating and using plugins.
-
-## Supported printers
-Please check our [Wiki page](https://github.com/Ultimaker/Cura/wiki/Adding-new-machine-profiles-to-Cura) for guidelines about adding support
-for new machines.
-
-## Configuring Cura
-Please check out [Wiki page](https://github.com/Ultimaker/Cura/wiki/Cura-Settings) about configuration options for developers.
-
-## Translating Cura
-Please check out [Wiki page](https://github.com/Ultimaker/Cura/wiki/Translating-Cura) about how to translate Cura into other languages.
-
-## License
-![License](https://img.shields.io/github/license/ultimaker/cura?style=flat)  
-Cura is released under terms of the LGPLv3 or higher. A copy of this license should be included with the software. Terms of the license can be found in the LICENSE file. Or at
-http://www.gnu.org/licenses/lgpl.html
-
-> But in general it boils down to:  
-> **You need to share the source of any Cura modifications**
+
+<br>
+
+<div align = center>
+
+[![Badge Issues]][Issues]   
+[![Badge PullRequests]][PullRequests]   
+[![Badge Closed]][Closed]
+
+[![Badge Size]][#]   
+[![Badge License]][License]   
+[![Badge Contributors]][Contributors]
+
+[![Badge Test]][Test]   
+[![Badge Conan]][Conan]   
+
+<br>
+<br>
+
+![Logo]
+
+# Ultimaker Cura
+
+*State-of-the-art slicer app to prepare* <br>
+*your 3D models for your 3D printer.*
+
+*With hundreds of settings & community-managed print profiles,* <br>
+*Ultimaker Cura is sure to lead your next project to a success.*
+
+<br>
+<br>
+
+[![Button Building]][Building]   
+[![Button Plugins]][Plugins]   
+[![Button Machines]][Machines]
+
+[![Button Report]][Report]   
+[![Button Settings]][Settings]   
+[![Button Localize]][Localize]
+
+<br>
+<br>
+
+![Showcase]
+
+</div>
+
+<br>
+
+
+<!----------------------------------------------------------------------------->
+
+[Contributors]: https://github.com/Ultimaker/Cura/graphs/contributors
+[PullRequests]: https://github.com/Ultimaker/Cura/pulls
+[Machines]: https://github.com/Ultimaker/Cura/wiki/Adding-new-machine-profiles-to-Cura
+[Building]: https://github.com/Ultimaker/Cura/wiki/Running-Cura-from-Source
+[Localize]: https://github.com/Ultimaker/Cura/wiki/Translating-Cura
+[Settings]: https://github.com/Ultimaker/Cura/wiki/Cura-Settings
+[Plugins]: https://github.com/Ultimaker/Cura/wiki/Plugin-Directory
+[Closed]: https://github.com/Ultimaker/Cura/issues?q=is%3Aissue+is%3Aclosed
+[Issues]: https://github.com/Ultimaker/Cura/issues
+[Conan]: https://github.com/Ultimaker/Cura/actions/workflows/conan-package.yml
+[Test]: https://github.com/Ultimaker/Cura/actions/workflows/unit-test.yml
+
+[Showcase]: cura-logo.PNG
+[License]: LICENSE
+[Report]: docs/Report.md
+[Logo]: resources/images/cura-icon.png
+[#]: #
+
+
+<!---------------------------------[ Badges ]---------------------------------->
+
+[Badge Contributors]: https://img.shields.io/github/contributors/ultimaker/cura?style=for-the-badge&logoColor=white&labelColor=db5e8a&color=ab4a6c&logo=GitHub
+[Badge PullRequests]: https://img.shields.io/github/issues-pr/ultimaker/cura?style=for-the-badge&logoColor=white&labelColor=bb9f3e&color=937d31&logo=GitExtensions
+[Badge License]: https://img.shields.io/badge/License-LGPL3-336887.svg?style=for-the-badge&labelColor=458cb5&logoColor=white&logo=GNU
+[Badge Closed]: https://img.shields.io/github/issues-closed/ultimaker/cura?style=for-the-badge&logoColor=white&labelColor=629944&color=446a30&logo=AddThis
+[Badge Issues]: https://img.shields.io/github/issues/ultimaker/cura?style=for-the-badge&logoColor=white&labelColor=c34360&color=933349&logo=AdBlock
+[Badge Conan]: https://img.shields.io/github/workflow/status/Ultimaker/Cura/conan-package?style=for-the-badge&logoColor=white&labelColor=6185aa&color=4c6987&logo=Conan&label=Conan%20Package
+[Badge Test]: https://img.shields.io/github/workflow/status/Ultimaker/Cura/unit-test?style=for-the-badge&logoColor=white&labelColor=4a999d&color=346c6e&logo=Codacy&label=Unit%20Test
+[Badge Size]: https://img.shields.io/github/repo-size/ultimaker/cura?style=for-the-badge&logoColor=white&labelColor=715a97&color=584674&logo=GoogleAnalytics
+
+
+<!---------------------------------[ Buttons ]--------------------------------->
+
+[Button Localize]: https://img.shields.io/badge/Help_Localize-e2467d?style=for-the-badge&logoColor=white&logo=GoogleTranslate
+[Button Machines]: https://img.shields.io/badge/Adding_Machines-yellow?style=for-the-badge&logoColor=white&logo=CloudFoundry
+[Button Settings]: https://img.shields.io/badge/Configuration-00979D?style=for-the-badge&logoColor=white&logo=CodeReview
+[Button Building]: https://img.shields.io/badge/Building_Cura-blue?style=for-the-badge&logoColor=white&logo=GitBook
+[Button Plugins]: https://img.shields.io/badge/Plugin_Usage-569A31?style=for-the-badge&logoColor=white&logo=ROS
+[Button Report]: https://img.shields.io/badge/Report_Issues-C9284D?style=for-the-badge&logoColor=white&logo=Cliqz
+
+
diff --git a/docs/Report.md b/docs/Report.md
new file mode 100644
index 0000000000..8b24903878
--- /dev/null
+++ b/docs/Report.md
@@ -0,0 +1,81 @@
+
+# Reporting Issues
+
+Please attach the following information in case <br>
+you want to report crashing or similar issues.
+
+<br>
+
+## DxDiag
+
+### ![Badge Windows]
+
+The log as produced by **dxdiag**.
+
+<kbd>  start  </kbd>  »  <kbd>  run  </kbd>  »  <kbd>  dxdiag  </kbd>  »  <kbd>  save output  </kbd>
+
+<br>
+<br>
+
+## Cura GUI Log
+
+If the Cura user interface still starts, you can also <br>
+reach these directories from the application menu:
+
+<kbd>  Help  </kbd>  »  <kbd>  Show settings folder  </kbd>
+
+<br>
+
+### ![Badge Windows]
+
+```
+%APPDATA%\cura\<Ｃｕｒａ Ｖｅｒｓｉｏｎ>\cura.log
+```
+
+or
+
+```
+C:\Users\<your username>\AppData\Roaming\cura\<Ｃｕｒａ Ｖｅｒｓｉｏｎ>\cura.log
+```
+
+<br>
+
+### ![Badge Linux]
+
+```
+~/.local/share/cura/<Ｃｕｒａ Ｖｅｒｓｉｏｎ>/cura.log
+```
+
+<br>
+
+### ![Badge MacOS]
+
+```
+~/Library/Application Support/cura/<Ｃｕｒａ Ｖｅｒｓｉｏｎ>/cura.log
+```
+
+<br>
+<br>
+
+## Alternative
+
+An alternative is to install the **[ExtensiveSupportLogging]** <br>
+plugin this creates a zip folder of the relevant log files.
+
+If you're experiencing performance issues, we might ask <br>
+you to connect the CPU profiler in this plugin and attach <br>
+the collected data to your support ticket. 
+
+<br>
+
+
+<!----------------------------------------------------------------------------->
+
+[ExtensiveSupportLogging]: https://marketplace.ultimaker.com/app/cura/plugins/UltimakerPackages/ExtensiveSupportLogging
+
+
+<!---------------------------------[ Badges ]---------------------------------->
+
+[Badge Windows]: https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logoColor=white&logo=Windows
+[Badge Linux]: https://img.shields.io/badge/Linux-00A95C?style=for-the-badge&logoColor=white&logo=Linux
+[Badge MacOS]: https://img.shields.io/badge/MacOS-403C3D?style=for-the-badge&logoColor=white&logo=MacOS