administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2026-02-05 18:55:23 +03:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Add docs

Browse Source
This commit is contained in:
Nick Mowen 2023-07-10 15:18:43 -06:00
parent 2e57e92dcd
commit 1cc03be313
2 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/docs/development/contributing-boards.md Normal file
View File

@ -0,0 +1,19 @@
---
id: contributing-boards
title: Community Supported Boards
---
## About Community Supported Boards
There are many examples of SBCs (small board computers) that hav a passionate community behind them, Jetson Nano for example. These SBCs often have dedicated hardware that can greatly accelerate Frigate's AI and video workloads, but this hardware requires very specific frameworks for interfacing with it.
This means it would be very difficult for Frigate's maintainers to support these different boards especially given the relatively low userbase.
The community support boards framework allows a user in the community to be the codeowner to add support for an SBC or other detector by providing the code, maintenance, and user support.
## Getting Started
1. Follow the steps from [the main contributing docs](/development/contributing.md).
2. Create a new build type under `docker/build`
3. Create a Dockerfile and use `BASE_IMAGE` as the base, `docker/build/rpi/Dockerfile` can be used as an example for this.
4. Create install_deps.sh to install any deps needed for the device.

2
docs/docs/development/contributing.md
View File

@ -1,6 +1,6 @@
--- ---
id: contributing id: contributing
title: Contributing title: Contributing To The Main Code Base
--- ---
## Getting the source ## Getting the source