docs rewrite

blakeblackshear · Oct 24, 2020 · 5a081e4 · 5a081e4
1 parent 4feae47
commit 5a081e4
Show file tree

Hide file tree

Showing 9 changed files with 541 additions and 464 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -1,5 +1,5 @@
 README.md
-diagram.png
+docs/
 .gitignore
 debug
 config/

diff --git a/README.md b/README.md
diff --git a/config/back-mask.bmp b/config/back-mask.bmp
diff --git a/config/config.example.yml b/config/config.example.yml
diff --git a/docs/HWACCEL.md b/docs/HWACCEL.md
diff --git a/docs/CAMERAS.md → docs/cameras.md b/docs/CAMERAS.md → docs/cameras.md
@@ -16,8 +16,6 @@ input_args:
  - experimental
  - -fflags
  - +genpts+discardcorrupt
- - -vsync
- - drop
  - -use_wallclock_as_timestamps
  - '1'
 ```
diff --git a/diagram.png → docs/diagram.png b/diagram.png → docs/diagram.png
diff --git a/docs/frigate.png b/docs/frigate.png
diff --git a/docs/how-frigate-works.md b/docs/how-frigate-works.md
@@ -0,0 +1,10 @@
+# How Frigate Works
+Frigate is designed to minimize resource and maximize performance by only looking for objects when and where it is necessary
+
+![Diagram](diagram.png)
+
+## 1. Look for Motion
+
+## 2. Calculate Detection Regions
+
+## 3. Run Object Detection