| ... | ... | @@ -9,9 +9,9 @@ Deterrence Dispensed uses a set of standards for quality product releases, and a |
|
|
|
| :file_folder: **STEP** | :no_entry: | :heavy_check_mark: | STEP file exports of the assemblies (whole product) or assembly variants |
|
|
|
|
| :file_folder: **STEP**/Reference | 🔹 | 🔹 | STEP file exports of reference CAD models used to support design of the printed model |
|
|
|
|
| :file_folder: **STL** | Yes | :heavy_check_mark: | STL file exports of every printable object, including a blank STL version with no branding or texturing |
|
|
|
|
| :page_facing_up: **README.md** | Yes | :heavy_check_mark: | documentation in the file of this template in Markdown format at the root of the package. [Click here for the required template](https://gitlab.deterrencedispensed.com/deterrence-dispensed/information-and-tutorials/-/wikis/For-Developers/Resources/Release-Package-Requirements/README.md-Sample) |
|
|
|
|
| :page_facing_up: **README.md** | Yes | :heavy_check_mark: | Documentation in the file of this template in Markdown format at the root of the package. [Click here for the required template](https://gitlab.deterrencedispensed.com/deterrence-dispensed/information-and-tutorials/-/wikis/For-Developers/Resources/Release-Package-Requirements/README.md-Sample) |
|
|
|
|
| :page_with_curl: **LICENSE.txt** | :no_entry: | 🔹* | A license for the products, files, and documentation in your release package (that belong to you/your organization). |
|
|
|
|
| :notebook: **Assembly Guide PDF** | 🔹 | :heavy_check_mark:* | Documentation in the file of this template in Markdown format at the root of the package. |
|
|
|
|
| :notebook: **Assembly Guide PDF** | 🔹 | :heavy_check_mark:* | Documentation in the file of this template in Markdown format at the root of the package. [A sample can be found here.](For-Developers/Resources/Release-Package-Requirements/Assembly-PDF-Sample) |
|
|
|
|
| :notebook: **Assembly Video** | 🔹 | 🔹 | A brief video demonstrating general assembly may be included, without narration |
|
|
|
|
| :notebook: **Build Guide Video** | 🔹 | 🔹 | A comprehensive video, demonstrating the entirety of the PDF through the build process, with narration, is strongly recommended. |
|
|
|
|
|
| ... | ... | @@ -63,7 +63,7 @@ One unique requirement for the STL folder is that parts of an assembly meant to |
|
|
|
|
|
|
|
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](README.md Sample). **YOU MUST USE THIS TEMPLATE.**
|
|
|
|
You can find an up-to-date template [here](For-Developers/Resources/Release-Package-Requirements/README.md-Sample). **YOU MUST USE THIS TEMPLATE.**
|
|
|
|
|
|
|
|
## :page_with_curl: **LICENSE.txt**
|
|
|
|
|
| ... | ... | |
