docs: note for csgt.vn api, tesseract, dev require uv, just

check-phat-nguoi · Jan 12, 2025 · 4863866 · 4863866
1 parent 1400a74
commit 4863866
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 4 deletions.
diff --git a/docs/dev/setup.md b/docs/dev/setup.md
@@ -1,5 +1,10 @@
 # Setup
 
+Requirements:
+
+- [uv](https://github.com/astral-sh/uv)
+- [just](https://github.com/casey/just)
+
 ## Run check-phat-nguoi
 
 ```sh
@@ -12,12 +17,18 @@ just
 just s
 ```
 
-## Build web
+## Dev web
 
 ```sh
 just w
 ```
 
+## Build web
+
+```sh
+just wb
+```
+
 # Test on production with python 3.10
 
 ```sh

diff --git a/docs/usage/usage.md b/docs/usage/usage.md
@@ -1,12 +1,16 @@
 # Hướng dẫn sử dụng
 
-## Cài đặt python
+## Yêu cầu
 
-- <https://www.python.org/downloads/>
+- [Python](https://www.python.org/downloads/)
+- [Tesseact OCR CLI](https://tesseract-ocr.github.io/tessdoc/Installation.html) (Không bắt buộc)(1)
+  { .annotate }
+
+      1. Sử dụng để giải captcha đối với API csgt.vn
 
 ??? note
 
-    Project được viết bằng python 3.13 nhưng có thể chạy với python 3.10 trở lên (không đảm bảo)
+    Project được viết bằng python 3.13 nhưng có thể chạy với python 3.10 trở lên (không đảm bảo). Đối với discord notification yêu cầu phiên bản >= 3.13.
 
 ---
 
@@ -71,6 +75,14 @@ Thiết lập file `config.json` (1)
     {% include "../../config.sample.json" %}
     ```
 
+???+ note
+
+    Xem [`Config Schema`](https://ntgnguyen.github.io/check-phat-nguoi/schemas/config.html) để biết chi tiết config
+
+???+ warning
+
+    Hiện tại API từ csgt.vn không đảm bảo hoạt động.
+
 ### Chạy chương trình
 
 ???+ note