DOCSEARCHbyAlgolia
Submit Docs

Variant Documentation

website·Indexed 29 days ago

https://variant.taranium.xyz/

Guides and tutorials for creating hardware projects with unique gimmicks. Includes resources on CAD design, PCB creation using KiCad and EasyEDA, custom keycap manufacturing, and project documentation for Hack Club.

Tokens
5.5K
Snippets
13
Records
51
Agent score
41%

What's inside Variant

  1. Overview of the Variant hardware program

    Variant is a 'You Ship, We Ship' (YSWS) program run by Hack Club, a 501(c)(3) non-profit. The program provides funding and a merch pack to teens (aged 13-18) who create hardware projects with a unique or 'weird' gimmick.

  2. Place symbols and wires for clarity

    Adhere to these wiring and placement practices:

    • Symbol Separation: Never let two symbols touch directly; always place a wire between them.
    • Pin Connections: When connecting multiple pins (e.g., on a microcontroller) to the same net, do not run a single wire through all the pins. Instead, draw a main bus/wire and connect each pin to it individually with short perpendicular segments.

  3. Create the README.md for Variant submission

    The README.md file must include the following sections:

    • Project Description: A short description of the project and a few sentences explaining why it was created.
    • Visuals:
      • A screenshot of the full 3D model.
      • A screenshot of the PCB (if applicable).
      • A wiring diagram (if wiring is used instead of a PCB).
    • Gimmick: An explanation of the project's gimmick.
    • BOM: A Bill of Materials presented in table format at the end of the file.

  5. Apply text styling for emphasis in Markdown

    Use italics and bold text to provide emphasis and remove monotony from technical documentation. Avoid using underlines, as they are often mistaken for broken hyperlinks. For extreme emphasis, combine italics and bolding, or use emojis. For small, semi-offtopic comments or stylistic flourishes, use the HTML <sub> tag for subscripting, which is supported by most Markdown processors.
    <sub>This is a small subscript comment</sub>

  6. Format text with bold, italics, and quotes

    Use the following symbols for text styling:

    • Italics: Wrap text in single asterisks (*text*).
    • Bold: Wrap text in double asterisks (**text**).
    • Quotes: Start a line with the greater-than symbol and a space (> ).
    • Horizontal Rules: Use three dashes (---) on a new line to create a thematic break.
    *This is italic*
**This is bold**

> This is a blockquote

---

  7. Requirements for project journal entries

    Project journals must be written in real-time as projects are developed; retroactive writing is discouraged. To be valid, each journal entry must contain:

    1. Visual Evidence: Images of progress, such as schematics, datasheets, designed parts, or referenced diagrams.
    2. Technical Descriptions: Text explaining what was done and the methodology used.
    3. Planning: Goals or to-do lists for the next entry or remaining tasks.
    4. Time Tracking: The total amount of time spent on the project for that specific entry.

    Constraint: Do not use AI to write journals. Focus on authentic descriptions of how the project works and personal reflections rather than 'optimal' writing styles.

  8. Create headings in Markdown

    Use hashtags (#) at the start of a line to create titles. Ensure there is a space between the hashtag and the title text. The number of hashtags determines the heading level (e.g., # for H1, ## for H2, ### for H3).
    # Main Title
## Subheading
### Smaller Heading

  9. Design and development workflow for Variant projects

    The recommended workflow for starting a hardware project in Variant is:

    1. Initialization: Create a GitHub repository to journal ideas and project progress.
    2. Research: Document what you want to make, brainstorm implementation methods, and identify potential problems and solutions.
    3. Prototyping: Flesh out the project's appearance and create designs in CAD software.
    4. Support: Use online forums (e.g., Reddit, Hack Club Slack #variant channel) or YouTube for technical guidance.

  11. Requirements for a working Variant hardware project

    To be considered a working project in Variant, you must provide the following three components to demonstrate how the project works and how others can replicate it:

    1. A PCB or wiring diagram detailing the circuitry.
    2. A full assembly or model designed in CAD (Computer Aided Design) software.
    3. Mock firmware for the project (it does not need to be 100% functional, but an attempt at writing it is required).

  12. Design a 3D-printable Butt Hinge in CAD

    A butt hinge is a versatile hinge commonly used for doors. For 3D printing, instead of a metal pin, a piece of 3D printer filament can be used as the pin; its natural curvature helps it stay in place. While this guide uses Shapr3D, the workflow is transferable to most CAD software (e.g., Onshape).