Release Package Requirements

This is an old version of this page. You can view the most recent version or browse the history.

Deterrence Dispensed uses a set of standards for quality product releases, and as such, we define a minimum-viable product release package with the contents as listed below:

Directory/File	Required?	Description
📁 Documentation	✔	Rich documentation in form of formatted guides or videos
📁 Native	❌	Native editor binaries, for example exports from Fusion 360 or SolidWorks
📁 Renders	✔	3D renders or real-world images of the product
📁 Remixes	❌	A collected of user-submitted remixes. Only applicable if your initial release is to include user submissions.
📁 STEP	✔	STEP file exports of the assemblies (whole product) or assembly variants
📁 STEP/Reference	❌	STEP file exports of reference CAD models used to support design of the printed model
📁 STL	✔	STL file exports of every printable object, including a blank STL version with no branding or texturing
📄 README.md	✔	documentation in the file of this template in Markdown format at the root of the package. Click here for the required template
📃 LICENSE.txt	❌*	A license for the products, files, and documentation in your release package (that belong to you/your organization).
📓 Assembly Guide PDF	✔**	Documentation in the file of this template in Markdown format at the root of the package.

📁 Documentation

Under construction

📁 Native

Under construction

📁 Renders

Under construction

📁 Remixes

Under construction

📁 STEP

Under construction

📁 STL

Under construction

📄 README.md

The README.md file is essential to accurately describe to our internal indexing and documentation workflow, as well as providing a parse-able file for GitLab and other indexing services to display.

You can find an up-to-date template here.

📃 LICENSE.txt

Under construction

📓 Assembly Guide PDF

Under construction