diff --git a/README.md b/README.md index 8ec3101ef6..fbcca8fbf9 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,23 @@ # Cura

- - - - - - - - - - - - - - - - + +[![Badge Test]][Test] +[![Badge Conan]][Conan] +[![Badge Issues]][Issues] +[![Badge Closed]][Closed] +[![Badge PullRequests]][PullRequests] +[![Badge Contributors]][Contributors] +[![Badge Size]][#] +[![Badge Test]][Test] +[![Badge License]][License] +

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) +![Showcase] ## Logging Issues @@ -35,30 +30,64 @@ For crashes and similar issues, please attach the following information: * `$HOME/.local/share/cura//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) +An alternative is to install the [ExtensiveSupportLogging Plugin] 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. +Please check our [Wiki page][Building] 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. +Please check our [Wiki page][Plugins] 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 +Please check our [Wiki page][Machines] 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. +Please check out [Wiki page][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. +Please check out [Wiki page][Localize] about how to translate Cura into other languages. ## License -![License](https://img.shields.io/github/license/ultimaker/cura?style=flat) +![Badge License] 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** + + + + +[ExtensiveSupportLogging Plugin]: https://marketplace.ultimaker.com/app/cura/plugins/UltimakerPackages/ExtensiveSupportLogging +[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 +[#]: # + + + + +[Badge Contributors]: https://img.shields.io/github/contributors/ultimaker/cura +[Badge PullRequests]: https://img.shields.io/github/issues-pr/ultimaker/cura +[Badge License]: https://img.shields.io/github/license/ultimaker/cura?style=flat +[Badge Closed]: https://img.shields.io/github/issues-closed/ultimaker/cura?color=g +[Badge Issues]: https://img.shields.io/github/issues/ultimaker/cura +[Badge Conan]: https://github.com/Ultimaker/Cura/actions/workflows/conan-package.yml/badge.svg +[Badge Test]: https://github.com/Ultimaker/Cura/actions/workflows/unit-test.yml/badge.svg +[Badge Size]: https://img.shields.io/github/repo-size/ultimaker/cura?style=flat + +