| ... | ... | @@ -17,7 +17,7 @@ Deterrence Dispensed uses a set of standards for quality product releases, and a |
|
|
|
|
|
|
|
## :file_folder: Documentation
|
|
|
|
|
|
|
|
Under construction
|
|
|
|
Use this folder to store extra documentation or history for your project, if you wish to include it. Ideally, the PDF/assembly guide should be a conclusive piece of documentation, but if your project is complex and requires distinct and discrete guides, this folder is the place to put it.
|
|
|
|
|
|
|
|
## :file_folder: Native
|
|
|
|
|
| ... | ... | @@ -33,7 +33,11 @@ The Renders folder should include images (in PNG or JPEG format no larger than 1 |
|
|
|
|
|
|
|
## :file_folder: Remixes
|
|
|
|
|
|
|
|
Under construction
|
|
|
|
The release package can contain user submitted remixes. Remixes must be organized by username in folders, of which contain the files in a similar structure to the release package (STL, STEP, Renders, etc.).
|
|
|
|
|
|
|
|
The requirements for a remix submission are relaxed- **as long as they are derived from the latest release candidate before release**.
|
|
|
|
|
|
|
|
The Remixes folder must have a release index, [using this format.](For-Developers/Guides/Resources/Remixes/README.md-Sample)
|
|
|
|
|
|
|
|
## :file_folder: STEP
|
|
|
|
|
| ... | ... | @@ -51,7 +55,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 can find an up-to-date template [here](README.md Sample). **YOU MUST USE THIS TEMPLATE.**
|
|
|
|
|
|
|
|
## :page_with_curl: **LICENSE.txt**
|
|
|
|
|
| ... | ... | @@ -59,7 +63,11 @@ Under construction |
|
|
|
|
|
|
|
## :notebook: **Assembly Guide PDF**
|
|
|
|
|
|
|
|
Under construction
|
|
|
|
Through documentation, including assembly steps and photos should be included in a fixed document in PDF format.
|
|
|
|
|
|
|
|
> ⚠ **NOTE:** This requirement can be forgone if:
|
|
|
|
> - a video assembly guide is created and included/linked with the release package
|
|
|
|
> - a video depicting assembly is linked online **where the assembly steps** are conclusively similar/identical between a printed and original, factory model.
|
|
|
|
|
|
|
|
|
|
|
|
|
