Skip to content

Commit

Permalink
Update readme with instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
KenwoodFox authored Jan 6, 2025
1 parent 17092a6 commit 1b9498a
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[![ProjectHUD CI](https://github.com/FRC-1721/ProjectHud/actions/workflows/build_docker.yml/badge.svg)](https://github.com/FRC-1721/ProjectHud/actions/workflows/build_docker.yml)

# Project Hud

Flask server for displaying a quick development HUD (built specifically for use with FRC1721's code environment.

![image](https://github.com/user-attachments/assets/4e62c869-bbb0-4391-9818-1196055490b4)

## Development

```shell
pipenv shell
flask run --debug
```

## Deploy

Deployment is handled with docker.

```yaml
# Example Docker Compose File

services:
project_hud:
image: ghcr.io/frc-1721/project_hud-bot:main
environment:
TZ: America/New_York
GITHUB_TOKEN: YOUR_TOKEN
GITHUB_REPOS: YOUR,REPOS
```

0 comments on commit 1b9498a

Please sign in to comment.