... | ... | @@ -2,8 +2,8 @@ Deterrence Dispensed uses a set of standards for quality product releases, and a |
|
|
|
|
|
| Directory/File | Required? | Description |
|
|
|
| ------ | ------ | ------ |
|
|
|
| :file_folder: **Documentation** | :heavy_check_mark: | Rich documentation in form of formatted guides or videos |
|
|
|
| :file_folder: **Native** | :x: | Native editor binaries, for example exports from Fusion 360 or SolidWorks |
|
|
|
| :file_folder: **Documentation** | :x:* | Supplementary documentation for particularly involved assemblies |
|
|
|
| :file_folder: **Native** | :x: | Native editor binaries |
|
|
|
| :file_folder: **Renders** | :heavy_check_mark: | 3D renders or real-world images of the product |
|
|
|
| :file_folder: **Remixes** | :x: | A collected of user-submitted remixes. _Only applicable if your initial release is to include user submissions._ |
|
|
|
| :file_folder: **STEP** | :heavy_check_mark: | STEP file exports of the assemblies (whole product) or assembly variants |
|
... | ... | @@ -11,7 +11,9 @@ Deterrence Dispensed uses a set of standards for quality product releases, and a |
|
|
| :file_folder: **STL** | :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** | :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](README.md Sample) |
|
|
|
| :page_with_curl: **LICENSE.txt** | :x:* | 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. |
|
|
|
|
|
|
> **\*** indicates additional conditions and elaborations as described in this process guidance document.
|
|
|
|
|
|
## :file_folder: Documentation
|
|
|
|
... | ... | @@ -19,11 +21,15 @@ Under construction |
|
|
|
|
|
## :file_folder: Native
|
|
|
|
|
|
Under construction
|
|
|
The Native folder is used for storing complete assemblies in the format used by the editor of the author's choice. This may include SolidWorks assembly files, Fusion360 exported assemblies, or Inventor IPTs.
|
|
|
|
|
|
Be sure to include referenced assemblies in the native export as well, and resolve any dependencies.
|
|
|
|
|
|
## :file_folder: Renders
|
|
|
|
|
|
Under construction
|
|
|
The Renders folder should include images (in PNG or JPEG format no larger than 10 MB) that would be used for media releases and thumbnails for indexes. Ideally, they are a collection of real-world pictures, and 3D renders/screenshots.
|
|
|
|
|
|
> :warning: **IMPORTANT!** Before even _committing_ any image files (especially JPEGs) to your repo, be sure to REMOVE and SCRUB your files for any EXIF data. This data can be used to identify you and your location!
|
|
|
|
|
|
## :file_folder: Remixes
|
|
|
|
... | ... | @@ -31,11 +37,15 @@ Under construction |
|
|
|
|
|
## :file_folder: STEP
|
|
|
|
|
|
Under construction
|
|
|
The STEP folder should have an exported, **complete** assembly from your editor. This is NOT the same as a native file- the STEP files are a universal CAD format recognized by many CAD applications out there.
|
|
|
|
|
|
A single STEP file containing an entire assembly is recommended, however, if there are variants to an assembly, a STEP file of each variant is strongly recommended.
|
|
|
|
|
|
## :file_folder: STL
|
|
|
|
|
|
Under construction
|
|
|
The STL folder should include the exported mesh files from your CAD editor. These will the files used for a slicer for 3D printing.
|
|
|
|
|
|
One unique requirement for the STL folder is that parts of an assembly meant to be printed must be saved as a separate STL file.
|
|
|
|
|
|
## :page_facing_up: **README.md**
|
|
|
|
... | ... | |