Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/Ultimaker/Cura.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChrisTerBeke <ctbeke@gmail.com>2017-12-18 22:50:45 +0300
committerGitHub <noreply@github.com>2017-12-18 22:50:45 +0300
commitcab27711ad94a3ce0e8b9a3239d24757349c49d5 (patch)
tree188fe66f56230be733b1fbe2492818c190c4d3cf /README.md
parentd6c6aa1c7197775d51292d3c746369875b41e983 (diff)
Cleanup readme
Cleanup readme now that we have better Wiki content
Diffstat (limited to 'README.md')
-rw-r--r--README.md57
1 files changed, 14 insertions, 43 deletions
diff --git a/README.md b/README.md
index 90f17a5463..a94ca853e6 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,16 @@
Cura
====
-
-This is the new, shiny frontend for Cura. [daid/Cura](https://github.com/daid/Cura.git) is the old legacy Cura that everyone knows and loves/hates.
-
-We re-worked the whole GUI code at Ultimaker, because the old code started to become unmaintainable.
-
+This is the new, shiny frontend for Cura. [daid/Cura](https://github.com/daid/Cura.git) is the old legacy Cura that everyone knows and loves/hates. We re-worked the whole GUI code at Ultimaker, because the old code started to become unmaintainable.
Logging Issues
------------
-Use [this](https://github.com/Ultimaker/Uranium/wiki/Bug-Reporting-Template) template to report issues. New issues that do not adhere to this template will take us a lot longer to handle and will therefore have a lower pirority.
-
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
- * $User/Library/Application Support/cura/`<Cura version>`/cura.log (OSX)
- * $USER/.local/share/cura/`<Cura version>`/cura.log (Ubuntu/Linux)
+ * `%APPDATA%\cura\<Cura version>\cura.log` (Windows), or usually `C:\Users\\<your username>\AppData\Roaming\cura\<Cura version>\cura.log`
+ * `$USER/Library/Application Support/cura/<Cura version>/cura.log` (OSX)
+ * `$USER/.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
@@ -24,15 +18,10 @@ For additional support, you could also ask in the #cura channel on FreeNode IRC.
Dependencies
------------
-
-* [Uranium](https://github.com/Ultimaker/Uranium)
- Cura is built on top of the Uranium framework.
-* [CuraEngine](https://github.com/Ultimaker/CuraEngine)
- This will be needed at runtime to perform the actual slicing.
-* [PySerial](https://github.com/pyserial/pyserial)
- Only required for USB printing support.
-* [python-zeroconf](https://github.com/jstasiak/python-zeroconf)
- Only required to detect mDNS-enabled printers
+* [Uranium](https://github.com/Ultimaker/Uranium) Cura is built on top of the Uranium framework.
+* [CuraEngine](https://github.com/Ultimaker/CuraEngine) This will be needed at runtime to perform the actual slicing.
+* [PySerial](https://github.com/pyserial/pyserial) Only required for USB printing support.
+* [python-zeroconf](https://github.com/jstasiak/python-zeroconf) Only required to detect mDNS-enabled printers
Configuring Cura
----------------
@@ -44,33 +33,15 @@ location = /[path_to_the..]/CuraEngine/build/CuraEngine
Build scripts
-------------
-
Please checkout [cura-build](https://github.com/Ultimaker/cura-build)
-Third party plugins
+Plugins
+-------------
+Please check our [Wiki](https://github.com/Ultimaker/Cura/wiki/Plugin-Directory) for details about creating and using plugins.
+
+Supported printers
-------------
-* [Post Processing Plugin](https://github.com/nallath/PostProcessingPlugin): Allows for post-processing scripts to run on g-code.
-* [Barbarian Plugin](https://github.com/nallath/BarbarianPlugin): Simple scale tool for imperial to metric.
-* [X3G Writer](https://github.com/Ghostkeeper/X3GWriter): Adds support for exporting X3G files.
-* [Auto orientation](https://github.com/nallath/CuraOrientationPlugin): Calculate the optimal orientation for a model.
-* [OctoPrint Plugin](https://github.com/fieldofview/OctoPrintPlugin): Send printjobs directly to OctoPrint and monitor their progress in Cura.
-* [Electric Print Cost Calculator Plugin](https://github.com/zoff99/ElectricPrintCostCalculator): Calculate the electric costs of a print.
-
-Making profiles for other printers
-----------------------------------
-If your make of printer is not in the list of supported printers, and using the "Custom FDM Printer" does not offer enough flexibility, you can use [this](https://github.com/Ultimaker/Cura/blob/master/resources/definitions/ultimaker_original.def.json) as a template.
-
-* Change the machine ID to something unique
-* Change the machine_name to your printer's name
-* If you have a 3D model of your platform you can put it in resources/meshes and put its name under platform
-* Set your machine's dimensions with machine_width, machine_depth, and machine_height
-* If your printer's origin is in the center of the bed, set machine_center_is_zero to true.
-* Set your print head dimensions with the machine_head_shape parameters
-* Set the start and end gcode in machine_start_gcode and machine_end_gcode
-
-Once you are done, put the profile you have made into resources/definitions, or in definitions in your cura profile folder.
-
-If you want to make a definition for a multi-extrusion printer, have a look at [this](https://github.com/Ultimaker/Cura/blob/master/resources/definitions/ultimaker_original_dual.def.json) as a template, along with the two extruder definitions it references [here](https://github.com/Ultimaker/Cura/blob/master/resources/extruders/ultimaker_original_dual_1st.def.json) and [here](https://github.com/Ultimaker/Cura/blob/master/resources/extruders/ultimaker_original_dual_2nd.def.json)
+Please check our [Wiki](https://github.com/Ultimaker/Cura/wiki/Adding-new-machine-profiles-to-Cura/_edit) for guidelines about adding support for new machines.
Translating Cura
----------------