Skip to content

Commit

Permalink
Update info.yaml
Browse files Browse the repository at this point in the history
updated documentation
  • Loading branch information
quardinlyttle authored Sep 7, 2023
1 parent 6137f47 commit 0eb94b6
Showing 1 changed file with 34 additions and 32 deletions.
66 changes: 34 additions & 32 deletions info.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,27 +27,29 @@ documentation:

# Longer description of how the project works. You can use standard markdown format.
how_it_works: |
4 bit Op Code ALU. OpCodes are as follows-
| Code | Operation |
| ---- | -------------------- |
| 0000 | AND |
| 0001 | OR |
| 0010 | NOT |
| 0011 | XOR |
| 0100 | NAND |
| 0101 | NOR |
| 0110 | XNOR |
| 0111 | Add |
| 1000 | Sub |
| 1001 | Multiplication |
| 1010 | Compare |
| 1011 | Shift Left Logically |
| 1100 | Shift R Logically |
| 1101 | Shift L Arithmetic |
| 1110 | Shift R Arithmetic |
| 1111 | Running Sum |

Running Sum takes the current 4bit number at the input and continously adds it to the output every second.
4 bit Op Code ALU. OpCodes are as follows-
- 0000 AND
- 0001 OR
- 0010 NOT
- 0011 XOR
- 0100 NAND
- 0101 NOR
- 0110 XNOR
- 0111 Addition
- 1000 Subtraction
- 1001 Multiplication
- 1010 Compare
- 1011 Shift L Logically
- 1100 Shift R Logically
- 1101 Shift L Arithmetically
- 1110 Shift R Arithmetically
- 1111 Running Sum
**Running Sum** takes the current 4bit number at the input and continously adds it to the output every second.
**Compare** is 2'b10 when A is greater than B, 2'b01 when B is greater than A. 2'b11 when equal.
**NOT** treats A and B as a combined 4bit input.
**Subtraction** anticipates am unsigned number input (treats them as positive numbers essentially) however will give signed output depending on the operation. It acts as A-B.
# 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: |
Expand Down Expand Up @@ -75,19 +77,19 @@ Running Sum takes the current 4bit number at the input and continously adds it t
- dot
# A description of what the bidirectional I/O pins do (e.g. I2C SDA, I2C SCL, etc)
bidirectional:
- none
- none
- none
- none
- none
- none
- none
- none
- Output bit 7
- Output bit 6
- Output bit 5
- Output bit 4
- Output bit 3
- Output bit 2
- Output bit 1
- Output bit 0

# The following fields are optional
tag: "" # 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
tag: "ALU, test, firstTapeOut" # 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: "an external circuit with LEDs or a BCD converter to represent the numerical outputs" # Describe any external hardware needed
discord: "donnel" # 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: 0 # Clock frequency in Hz (if required)
clock_hz: 10000000 # Clock frequency in Hz (if required)
picture: "" # relative path to a picture in your repository (must be 512kb or less)

0 comments on commit 0eb94b6

Please sign in to comment.