info.yaml

--- 
# TinyTapeout project information
project:
  wokwi_id:    348242239268323922        # If using wokwi, set this to your project's ID
#  source_files:        # If using an HDL, set wokwi_id as 0 and uncomment and list your source files here. Source files must be in ./src
#    - 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

# 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.
#
# Here is an example: https://github.com/mattvenn/tinytapeout_m_segments/blob/main/info.yaml
#
# This info will be automatically collected and used to make a datasheet for the chip.
documentation: 
  author:       "Alan Green"      # Your name
  discord:      "AlanGreen#3623"  # Your discord handle
  title:        "Siren"           # Project title
  description:  "Pretty patterns and a siren straight from the 1970s"      # Short description of what your project does
  how_it_works: >
    A long chain of D flip flops divides down the clock to produce a range of frequencies 
    that are used for various purposes.
    
    Some of the higher frequencies are used to produce the tones. Lower frequencies are
    used to control the patterns of lights and to change the tones being sent to the speaker.
    
    An interesting part of the project is a counter that counts to 5 and resets to zero.
    This is used for one of the two patterns of lights, where the period of pattern is six.
    
  how_to_test: >
    Connect a speaker to the last digital output pin, the one which is also connected to
    the decimal point on the seven segment display. Switch 8 is used to select between two
    groups of patterns.
  external_hw: >
    For the audio output on pin 7, either use an audio amplifier or, if bravely
    connecting a speaker directly, place a resistor in series to limit the current.
  language:     "wokwi" # other examples include Verilog, Amaranth, VHDL, etc
  doc_link:     ""      # URL to longer form documentation, eg the README.md in your repository
  clock_hz:     12500       # Clock frequency in Hz (if required)
  picture:      ""      # relative path to a picture in your repository
  inputs:               # a description of what the inputs do
    - clock
    - none
    - none
    - none
    - none
    - none
    - none
    - pattern_select
  outputs:
    - segment a         # a description of what the outputs do
    - segment b
    - segment c
    - segment d
    - segment e
    - segment f
    - segment g
    - none