|
|
|
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:
|
|
|
|
|
|
|
|
At the minimum, release package shall have the following files:
|
|
|
|
- :file_folder: **Renders**: 3D renders or real-world images of the product
|
|
|
|
- :file_folder: **STEP**: STEP file exports of every printable object
|
|
|
|
- :file_folder: **STL**: STL file exports of every printable object, including a blank STL version with no branding or texturing
|
|
|
|
- :newspaper: **README.md**: documentation in the file of this template in Markdown format at the root of the package.
|
|
|
|
|
|
|
|
Ideally, a comprehensive release package would have these files as well, but they are not required.
|
|
|
|
- :file_folder: **STEP**/Reference: STEP file exports of reference CAD models used to support design of the printed model
|
|
|
|
- :file_folder: **Native**: +native editor binaries, for example exports from Fusion 360 or SolidWorks
|
|
|
|
- :file_folder: **Documentation**: Rich documentation in form of formatted guides or videos |
|
|
\ No newline at end of file |
|
|
|
| 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: **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 |
|
|
|
|
| :file_folder: **STEP**/Reference | :x:| STEP file exports of reference CAD models used to support design of the printed model |
|
|
|
|
| :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. |
|
|
|
|
|
|
|
|
## :file_folder: Documentation
|
|
|
|
|
|
|
|
Under construction
|
|
|
|
|
|
|
|
## :file_folder: Native
|
|
|
|
|
|
|
|
Under construction
|
|
|
|
|
|
|
|
## :file_folder: Renders
|
|
|
|
|
|
|
|
Under construction
|
|
|
|
|
|
|
|
## :file_folder: Remixes
|
|
|
|
|
|
|
|
Under construction
|
|
|
|
|
|
|
|
## :file_folder: STEP
|
|
|
|
|
|
|
|
Under construction
|
|
|
|
|
|
|
|
## :file_folder: STL
|
|
|
|
|
|
|
|
Under construction
|
|
|
|
|
|
|
|
## :page_facing_up: **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](README.md Sample).
|
|
|
|
|
|
|
|
## :page_with_curl: **LICENSE.txt**
|
|
|
|
|
|
|
|
Under construction
|
|
|
|
|
|
|
|
## :notebook: **Assembly Guide PDF**
|
|
|
|
|
|
|
|
Under construction
|
|
|
|
|
|
|
|
|
|
|
|
|
