forked from TinyTapeout/tt03-submission-template
-
Notifications
You must be signed in to change notification settings - Fork 48
/
info.yaml
64 lines (56 loc) · 2.68 KB
/
info.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
---
# TinyTapeout project information
project:
wokwi_id: 0 # If using wokwi, set this to your project's ID
# If using an HDL, set wokwi_id as 0 and uncomment and list your source files here.
# Source files must be in ./src and you must list each source file separately
source_files:
- counter.v
- decoder.v
top_module: "seven_segment_seconds" # put the name of your top module here, make it unique by prepending your github username
# Keep a track of the submission yaml
yaml_version: 3.0
# As everyone will have access to all designs, try to make it easy for someone new to your design to know what
# it does and how to operate it. This info will be automatically collected and used to make a datasheet for the chip.
#
# Here is a great example: https://github.com/davidsiaw/tt02-davidsiaw-stackcalc/blob/38c5647f83aad2aec675d566aa3d67b98f0aac81/info.yaml
documentation:
author: "Matt Venn"
title: "7 segment seconds"
language: "Verilog"
description: "Count up to 10, one second at a time."
# Longer description of how the project works. You can use standard markdown format.
how_it_works: |
Uses a set of registers to divide the clock, and then some combinational logic
to convert from binary to decimal for the display.
Puts a slower square wave output on output 7.
# Instructions on how someone could test your project, include things like what buttons do what and how to set the clock if needed
how_to_test: |
After reset, the counter should increase by one every second.
# A description of what the inputs do
inputs:
- clock
- reset
- none
- none
- none
- none
- none
- none
# A description of what the outputs do
outputs:
- segment a
- segment b
- segment c
- segment d
- segment e
- segment f
- segment g
- slow clock output
# The following fields are optional
tag: "timer, test" # comma separated list of tags: test encryption, experiment, clock, animation, utility, industrial, pwm, fpga, alu, microprocessor, risc, riscv, sensor, signal generator, fft, filter, music, bcd, sound, serial, timer, random number generator, calculator, decoder, counter, puzzle, multiplier, game, oscillator,
external_hw: "" # Describe any external hardware needed
discord: "mattvenn#1907" # Your discord handle, used for communication and automatically assigning tapeout role after a submission
doc_link: "" # URL to longer form documentation, eg the README.md in your repository
clock_hz: 1000 # Clock frequency in Hz (if required)
picture: "" # relative path to a picture in your repository