Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cura 5555 ufp specification #12

Closed
wants to merge 6 commits into from
Closed
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/ufp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Ultimaker Format Package (UFP)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's cleaner to use the # annotation for headers (# = h1, ## = h2, etc).

============

Purpose:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--------
The goal of this file type is to provide required data for the 3D printer to perform a print job.

Structure:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--------
A UFP file contains the following files:</br>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Markdown you can use the following format for a list:

  • item 1
  • item 2
  • item 3
    • subitem

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not make 1 list with the file path and description per list item?

`\.rels`</br>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why backslashes?

`\Metadata\thumbnail.png`</br>
`\Cura\`</br>
`\3D\model.gcode`</br>
`\[Content_Types].xml`</br>
- The rels and content type files are filled with the required XML data.
- The thumbnail.png is a medium sized rendering of the 3D shape to show during file selection. There can be only one thumbnail.
- The model.gcode describes how a 3D printer should print a job.
- Possible content of Cura folder :</br>
&nbsp;&nbsp;*.xml.fdm_material – files describe materials specifications which might be needed for a print job.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Subitem instead of hardcodes spaces.


Notes:
-------------
- For the interchange of files between the Slicer and Printers, currently, ASCII GCODE files are used, in a specific Ultimaker flavor.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can use > to make a nice indented 'quote' annotation for stuff like this.

- In future development, the content of folder Cura might be changed.