Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding wokwi design submission guide #114

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
adding wokwi design submission guide
  • Loading branch information
kdotom committed Oct 5, 2024
commit 2a2ed78e9f998486437bf296bc083f5afb8d77d5
123 changes: 123 additions & 0 deletions content/guides/wokwi-submit-design/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
---
title: 'Submit Wokwi Design'
linktitle: 'Submit Wokwi Design'
description: 'Submit Wokwi Design'
weight: 60
---

# How to Submit Your Design to Tiny Tapeout

## What You'll Achieve

By the end of this guide you'll:

* Submit your design to the Tiny Tapeout shuttle for manufacturing.
* Understand how Tiny Tapeout aggregates hundreds of designs into one chip.
* Learn how to update your submission if you make changes.
* Learn how to purchase a PCB.

## Prerequisites

Before you begin, make sure you have:

* A GitHub repository created from the latest Wokwi or Verilog Tiny Tapeout template.
* Passing GDS and Docs Actions in your repository. This ensures your design meets the required standards.

{{< figure src="images/passing_indicators.png" >}}

## Understanding Tiles and Chips

In Tiny Tapeout:

* **Tiles** are individual design slots on the chip. Most participants have a free tile for their design.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove the 'most participants have a free tile', we are running workshops where this is not the case

* **Chips** are the actual physical chips manufactured. They contain all the tiles from different participants.

> **Note:** While you have a free tile for your design, receiving a physical PCB with your chip requires an additional purchase.

## Step-by-Step Submission Guide

### Log In to Tiny Tapeout

* Go to: [app.tinytapeout.com](http://app.tinytapeout.com)
* Click on **"Login with GitHub"**.
* Authorize the application if prompted.

### Submit Your Repository

{{< figure src="images/submit_design_1.png" >}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this image doesn't match what the person sees. you used the image from the front page of the website, but if they do as instructed and go to app.tinytapeout.com they'll see something different


* Once logged in, you'll see a field to paste your repository URL.
* Copy your GitHub repository URL.


{{< figure src="images/submit_design_2.png" >}}
{{< figure src="images/submit_design_3.png" >}}

* Paste it into the field and click **"Submit"**.

### Complete the Submission Process

* You have now submitted your design, but it’s not yet part of the tapeout.

{{< figure src="images/submit_design_4.png" >}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image is too low quality


* Click **"Submit a New Revision"** to add your design to the shuttle.
* Your design will then be added to the Tapeout.

> **Note:** You'll need to submit any revisions if changes are made before final submission.

### Apply Your Free Tile Coupon
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to: If you have a coupon code for a free tile


* During the submission, you'll have the option to apply a coupon for your free tile. (Feel free to ask for a coupon code.)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • If you have a coupon for a free tile, paste the code in and press the 'apply' link.

* Validate the coupon to ensure your tile is free of charge.

### Congratulations!

You've successfully submitted your design to the Tiny Tapeout shuttle. Your design is now queued for inclusion in the next manufacturing run.

## Important: Updating Your Submission

If you make any changes to your design after submission, you must update your submission.

### How to Update

1. Make changes to your design in your GitHub repository.
2. Ensure that all Actions (GDS and Docs) are passing.
3. Log back in to [app.tinytapeout.com](http://app.tinytapeout.com).
4. Resubmit your repository as before.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not clear enough, change to "Press the 'Submit a new revision' button"

5. The system will recognize that you're updating an existing submission.

### Tips

* Double-check your design before submitting to avoid the need for updates.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not very useful, what to double check for? If you keep this section, it should contain actionable prompts.

* Stay aware of submission deadlines to ensure your design is included.

## Purchasing a PCB

If you'd like to receive a physical PCB with your chip:

* Pre-purchase your PCB here: [Tiny Tapeout Prepurchase](#).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix the link


> **Note:** Only the first 100 boards are subsidized by Efabless, so act fast!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's now 80 instead of 100


## About Efabless

Efabless is our manufacturing partner, helping to make chip fabrication accessible. [Learn more about them here](#).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix the link


## Updating Documentation After the Shuttle Ends
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

move this into the tips section


Once the shuttle run has ended, to update your documentation:

* Follow this guide: [Updating Docs Post-Shuttle](#).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix the link


## Get Inspired by Other Designs

Looking for ideas or want to see what others have created?

* Browse past runs: [Tiny Tapeout Runs](#).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a link

* Check out a sample datasheet: [Sample Datasheet PDF (TT07)](#).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix the link


---

That's it! You’ve successfully learned how to use the Tiny Tapeout GitHub template to turn your design into ASIC files for manufacturing. Happy hacking!

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.