Skip to content

Commit

Permalink
Final README update before end of semester
Browse files Browse the repository at this point in the history
  • Loading branch information
ameyrk99 committed May 11, 2021
1 parent 0ce13b5 commit f309946
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 28 deletions.
34 changes: 6 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,12 @@
# LEDScoreboard

## About the files
- `main.py` displays logos along with the score (have to fix the timing for NHL)
- `text.py` simply displays text
Decoration LED Scoreboard to display your favorite games from NHL, NBA, MLB, and La Liga.

## Running the code
Since we only have a single hardware device, make a file like `tmp.py` to check your results. For example:
```py
# tmp.py for nhl
import nhl
![Demo photo](./img/demo1.png)

print(nhl.Scores.get_scores())
```
> Demo photo of a NBA game.
Sample output
```
[('PIT 2 - NYR 1', '13:28 2nd (LIVE)'), ('NJD 3 - BUF 4', 'TODAY (FINAL SO)')]
```
## Useful links
For more information on the project and setup guide check. <https://srdesignledboard.github.io/>

## Check PEP8 conventions
They are pretty simple and standard. Just for consistency in code from 6 people

Make executable
```bash
chmod +x check_pep8.sh
```

Run to check code
```bash
./check_pep8.sh
```

Commit only if it returns no output. And, add folders to the command in `check_pep8.py` if you create any packages.
For documentation on the code, check <https://srdesignledboard.github.io/documentation>
Binary file added img/demo1.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 f309946

Please sign in to comment.