Skip to content

Commit

Permalink
[Automated Workflow] Add/Modify READMEs (#3669)
Browse files Browse the repository at this point in the history
Regenerated READMEs

Co-authored-by: jrg94 <[email protected]>
  • Loading branch information
github-actions[bot] and jrg94 authored Dec 20, 2023
1 parent 5826180 commit 3f4cab5
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 26 deletions.
4 changes: 2 additions & 2 deletions archive/b/brainfuck/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Welcome to Sample Programs in Brainfuck! To find documentation related to the Brainfuck code in this repo, look [here.](https://sampleprograms.io/languages/brainfuck)

## Sample Programs List - 4/37 :disappointed:
## Sample Programs List - 5/37 :disappointed:

In this section, we feature a list of completed and missing programs in Brainfuck. See above for the current amount of completed programs in Brainfuck. If you see a program that is missing and would like to add it, please submit an issue, so we can assign it to you.

Expand All @@ -14,6 +14,7 @@ Below, you'll find a list of completed code snippets in Brainfuck. Code snippets
- :warning: [Fizz Buzz in Brainfuck](https://github.com//TheRenegadeCoder/sample-programs-website/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+fizz+buzz+brainfuck) [[Requirements](https://sampleprograms.io/projects/fizz-buzz)]
- :white_check_mark: [Hello World in Brainfuck](https://sampleprograms.io/projects/hello-world/brainfuck) [[Requirements](https://sampleprograms.io/projects/hello-world)]
- :warning: [Reverse String in Brainfuck](https://github.com//TheRenegadeCoder/sample-programs-website/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+reverse+string+brainfuck) [[Requirements](https://sampleprograms.io/projects/reverse-string)]
- :warning: [Rot13 in Brainfuck](https://github.com//TheRenegadeCoder/sample-programs-website/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+rot13+brainfuck) [[Requirements](https://sampleprograms.io/projects/rot13)]

### Missing Programs

Expand Down Expand Up @@ -48,7 +49,6 @@ The following list contains all of the approved programs that are not currently
- :x: [Quine](https://github.com/TheRenegadeCoder/sample-programs/issues/new?assignees=&labels=enhancement,quine&template=code-snippet-request.md&title=Add+Quine+in+Brainfuck) [[Requirements](https://sampleprograms.io/projects/quine)]
- :x: [Remove All Whitespace](https://github.com/TheRenegadeCoder/sample-programs/issues/new?assignees=&labels=enhancement,remove+all+whitespace&template=code-snippet-request.md&title=Add+Remove+All+Whitespace+in+Brainfuck) [[Requirements](https://sampleprograms.io/projects/remove-all-whitespace)]
- :x: [Roman Numeral](https://github.com/TheRenegadeCoder/sample-programs/issues/new?assignees=&labels=enhancement,roman+numeral&template=code-snippet-request.md&title=Add+Roman+Numeral+in+Brainfuck) [[Requirements](https://sampleprograms.io/projects/roman-numeral)]
- :x: [Rot13](https://github.com/TheRenegadeCoder/sample-programs/issues/new?assignees=&labels=enhancement,rot13&template=code-snippet-request.md&title=Add+Rot13+in+Brainfuck) [[Requirements](https://sampleprograms.io/projects/rot13)]
- :x: [Selection Sort](https://github.com/TheRenegadeCoder/sample-programs/issues/new?assignees=&labels=enhancement,selection+sort&template=code-snippet-request.md&title=Add+Selection+Sort+in+Brainfuck) [[Requirements](https://sampleprograms.io/projects/selection-sort)]
- :x: [Sleep Sort](https://github.com/TheRenegadeCoder/sample-programs/issues/new?assignees=&labels=enhancement,sleep+sort&template=code-snippet-request.md&title=Add+Sleep+Sort+in+Brainfuck) [[Requirements](https://sampleprograms.io/projects/sleep-sort)]
- :x: [Transpose Matrix](https://github.com/TheRenegadeCoder/sample-programs/issues/new?assignees=&labels=enhancement,transpose+matrix&template=code-snippet-request.md&title=Add+Transpose+Matrix+in+Brainfuck) [[Requirements](https://sampleprograms.io/projects/transpose-matrix)]
Expand Down
18 changes: 5 additions & 13 deletions archive/v/verilog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,14 @@

Welcome to Sample Programs in Verilog! To find documentation related to the Verilog code in this repo, look [here.](https://sampleprograms.io/languages/verilog)

## Sample Programs List - 2/37 :disappointed:
## Sample Programs List - 1/37 :disappointed:

In this section, we feature a list of completed and missing programs in Verilog. See above for the current amount of completed programs in Verilog. If you see a program that is missing and would like to add it, please submit an issue, so we can assign it to you.

### Completed Programs

Below, you'll find a list of completed code snippets in Verilog. Code snippets preceded by :warning: link to a GitHub issue query featuring a possible article request issue. If an article request issue doesn't exist, we encourage you to create one. Meanwhile, code snippets preceded by :white_check_mark: link to an existing article which provides further documentation. To see the list of approved projects, check out the official Sample Programs projects list.

- :warning: [Fibonacci in Verilog](https://github.com//TheRenegadeCoder/sample-programs-website/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+fibonacci+verilog) [[Requirements](https://sampleprograms.io/projects/fibonacci)]
- :warning: [Hello World in Verilog](https://github.com//TheRenegadeCoder/sample-programs-website/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+hello+world+verilog) [[Requirements](https://sampleprograms.io/projects/hello-world)]

### Missing Programs
Expand All @@ -27,6 +26,7 @@ The following list contains all of the approved programs that are not currently
- :x: [Duplicate Character Counter](https://github.com/TheRenegadeCoder/sample-programs/issues/new?assignees=&labels=enhancement,duplicate+character+counter&template=code-snippet-request.md&title=Add+Duplicate+Character+Counter+in+Verilog) [[Requirements](https://sampleprograms.io/projects/duplicate-character-counter)]
- :x: [Even Odd](https://github.com/TheRenegadeCoder/sample-programs/issues/new?assignees=&labels=enhancement,even+odd&template=code-snippet-request.md&title=Add+Even+Odd+in+Verilog) [[Requirements](https://sampleprograms.io/projects/even-odd)]
- :x: [Factorial](https://github.com/TheRenegadeCoder/sample-programs/issues/new?assignees=&labels=enhancement,factorial&template=code-snippet-request.md&title=Add+Factorial+in+Verilog) [[Requirements](https://sampleprograms.io/projects/factorial)]
- :x: [Fibonacci](https://github.com/TheRenegadeCoder/sample-programs/issues/new?assignees=&labels=enhancement,fibonacci&template=code-snippet-request.md&title=Add+Fibonacci+in+Verilog) [[Requirements](https://sampleprograms.io/projects/fibonacci)]
- :x: [File Input Output](https://github.com/TheRenegadeCoder/sample-programs/issues/new?assignees=&labels=enhancement,file+input+output&template=code-snippet-request.md&title=Add+File+Input+Output+in+Verilog) [[Requirements](https://sampleprograms.io/projects/file-input-output)]
- :x: [Fizz Buzz](https://github.com/TheRenegadeCoder/sample-programs/issues/new?assignees=&labels=enhancement,fizz+buzz&template=code-snippet-request.md&title=Add+Fizz+Buzz+in+Verilog) [[Requirements](https://sampleprograms.io/projects/fizz-buzz)]
- :x: [Fraction Math](https://github.com/TheRenegadeCoder/sample-programs/issues/new?assignees=&labels=enhancement,fraction+math&template=code-snippet-request.md&title=Add+Fraction+Math+in+Verilog) [[Requirements](https://sampleprograms.io/projects/fraction-math)]
Expand Down Expand Up @@ -55,18 +55,10 @@ The following list contains all of the approved programs that are not currently

## Testing

This language currently does not feature testing. If you'd like to help in the efforts to test all of the code in this repo, consider creating a testinfo.yml file with the following information:
The following list shares details about what we're using to test all Sample Programs in Verilog.

```yml
folder:
extension:
naming:

container:
image:
tag:
cmd:
```
- Docker Image: 0x01be/iverilog
- Docker Tag: latest

See the [Glotter2 project](https://github.com/rzuckerm/glotter2) for more information on how to create a testinfo file.

Expand Down
14 changes: 3 additions & 11 deletions archive/v/verve/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,18 +55,10 @@ The following list contains all of the approved programs that are not currently

## Testing

This language currently does not feature testing. If you'd like to help in the efforts to test all of the code in this repo, consider creating a testinfo.yml file with the following information:
The following list shares details about what we're using to test all Sample Programs in Verve.

```yml
folder:
extension:
naming:

container:
image:
tag:
cmd:
```
- Docker Image: rzuckerm/verve
- Docker Tag: 2018.06.24-1

See the [Glotter2 project](https://github.com/rzuckerm/glotter2) for more information on how to create a testinfo file.

Expand Down

0 comments on commit 3f4cab5

Please sign in to comment.