Skip to content

Commit

Permalink
nVious Retro FCX 890 documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jar committed Sep 6, 2024
1 parent c6eba95 commit c5dcc60
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 35 deletions.
47 changes: 16 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,26 @@
![](../../workflows/gds/badge.svg) ![](../../workflows/docs/badge.svg) ![](../../workflows/test/badge.svg) ![](../../workflows/fpga/badge.svg)

# Tiny Tapeout Verilog Project Template
# Tiny Tapeout nVious Retro FCX 890 Graphics

- [Read the documentation for project](docs/info.md)
![example VGA output](docs/screenshot.png)

## What is Tiny Tapeout?

Tiny Tapeout is an educational project that aims to make it easier and cheaper than ever to get your digital and analog designs manufactured on a real chip.

To learn more and get started, visit https://tinytapeout.com.

## Set up your Verilog project
This is an entry into the Tiny Tapeout Demoscene competition. This project
aims to add retro graphics to dozens of existing projects by intercepting the
binary output typically sent to the 7-segment LED display and redirecting it to
a VGA-compatible monitor.

1. Add your Verilog files to the `src` folder.
2. Edit the [info.yaml](info.yaml) and update information about your project, paying special attention to the `source_files` and `top_module` properties. If you are upgrading an existing Tiny Tapeout project, check out our [online info.yaml migration tool](https://tinytapeout.github.io/tt-yaml-upgrade-tool/).
3. Edit [docs/info.md](docs/info.md) and add a description of your project.
4. Adapt the testbench to your design. See [test/README.md](test/README.md) for more information.
The demo is targeting the following categories:

The GitHub action will automatically build the ASIC files using [OpenLane](https://www.zerotoasiccourse.com/terminology/openlane/).
- **Best single tile design** (~71% utilization)
- **Best graphics** (Retrowave Fuchsia Extreme mode (FCX On))
- **Most impressive for the size** (single tile features many color gradients, complex shapes, and 3D effect)
- **Most useful design** (adds stylized output compatible with dozens of existing projects)

## Enable GitHub actions to build the results page
[Read the documentation for project](docs/info.md)

- [Enabling GitHub Pages](https://tinytapeout.com/faq/#my-github-action-is-failing-on-the-pages-part)

## Resources

- [FAQ](https://tinytapeout.com/faq/)
- [Digital design lessons](https://tinytapeout.com/digital_design/)
- [Learn how semiconductors work](https://tinytapeout.com/siliwiz/)
- [Join the community](https://tinytapeout.com/discord)
- [Build your design locally](https://www.tinytapeout.com/guides/local-hardening/)
## What is Tiny Tapeout?

## What next?
Tiny Tapeout is an educational project that aims to make it easier and cheaper
than ever to get your digital and analog designs manufactured on a real chip.

- [Submit your design to the next shuttle](https://app.tinytapeout.com/).
- Edit [this README](README.md) and explain your design, how it works, and how to test it.
- Share your project on your social network of choice:
- LinkedIn [#tinytapeout](https://www.linkedin.com/search/results/content/?keywords=%23tinytapeout) [@TinyTapeout](https://www.linkedin.com/company/100708654/)
- Mastodon [#tinytapeout](https://chaos.social/tags/tinytapeout) [@matthewvenn](https://chaos.social/@matthewvenn)
- X (formerly Twitter) [#tinytapeout](https://twitter.com/hashtag/tinytapeout) [@tinytapeout](https://twitter.com/tinytapeout)
To learn more and get started, visit https://tinytapeout.com.
4 changes: 0 additions & 4 deletions docs/info.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ To test the user input functionality, connect the `ui_io[7:0]` pins. The idea
is that this would be a possibly useful graphical extension to the dozens of
existing projects that utilize the 7-segment LED display to show results.

### Advanced Configuration

TBD. (to configure LED colors/background)

## External hardware

Requires the [TinyVGA PMOD](https://github.com/mole99/tiny-vga)
Binary file added docs/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c5dcc60

Please sign in to comment.