Submission Requirements
Before submitting anything you should post in #variant for feedback. That way you can make it as good as possible before submitting
Generally all you need is a shipped project. The following requirements are the bare minimum, you are encouraged to go above and beyond in your projects. Add a render, give it a custom logo, or give it a nice looking readme!
YOUR PROJECT IS ACTUALLY COMPLETE:
- It has a complete CAD assembly, with all components (including electronics)
- You have firmware present, even if it's untested
- You have sanity checked your design with someone else
- (optional) you have a 3D render of your project!
YOUR GITHUB REPOSITORY CONTAINS ALL OF YOUR PROJECT FILES:
- a BOM, in CSV format in the root directory, WITH LINKS
- the source files for your PCB, if you have one (.kicad_pro, .kicad_sch, gerbers.zip, etc)
- A .STEP file of your project's 3D CAD model (and ideally the source design file format as well - .f3d, .shapr, onshape link, etc)
- ANY other files that are part of your project (firmware, libraries, references, etc)
if you're missing a .STEP file with all of your electronics and CAD, your project will not be approved
YOUR README.md FILE CONTAINS THE FOLLOWING:
- A short description of what your project is
- A couple sentences on why you made the project
PICTURES OF YOUR PROJECT\
- A screenshot of a full 3D model with your project
- A screenshot of your PCB, if you have one
- A wiring diagram, if you're doing any wiring that isn't on a PCB
- An explanation of your gimmick
- A BOM in table format at the end of the README
YOUR JOURNAL.md FILE CONTAINS THE FOLLOWING:
- Dates
- Time spent per day
- Pictures/videos of what you're working on
- Total time spent on the project at the top of the file
YOU DO NOT HAVE:
- AI Generated READMEs or Journal entries
- Stolen work from other people
- missing firmware/software