浏览代码

Renaming and documenting

Nikola Kotur 3 年之前
父节点
当前提交
37b606d2ab
共有 2 个文件被更改,包括 28 次插入0 次删除
  1. 28 0
      README.md
  2. 0 0
      sync.py

+ 28 - 0
README.md

@@ -2,6 +2,34 @@
 
 Dashcam video extractor and exporter.
 
+## About
+
+This project is a set of Python scripts I created to easily manage my Viofo dashcam. You might find it useful, but beware that my primary goal was to make my life easier, and I didn't focus a lot on making these tools reusable. But it will definitely serve as a good strating point. Most probably it'll work out of the box.
+
+## Requirements
+
+I built this on top of Debian system, so I advise you use that. Eventually I want to have this running on Rapsberry PI, but in the meantime, this is what it needs:
+
+* `python3-logzero`
+* `python3-pyudev`
+* `ncftp`
+
+## Scripts available
+
+### `sync.py`
+
+The end game is having Rapsberry PI box in garage, and after a drive, I'd take out MicroSD card from the dashcam, plug it in into Rapsberry PI box and it would automatically sync videos to NAS. This script is a start of that journey.
+
+This is how you should run it:
+
+```
+./run.py --ftp-password 123
+```
+
+Use `./run.py --help` to see what you can feed it with.
+
+After you run it, it will wait for USB drive to be inserted that has a partition (as it is the case with my dashcam). Once it detects is, it will join all video files of a certain day and upload that to nas using FTP protocol.
+
 ## Licensing
 
 This project is licensed under [Apache License 2.0](LICENSE.txt).

+ 0 - 0
run.py → sync.py