From beaa290c19bb9d0ec8c52f6f80f7be271ff963b7 Mon Sep 17 00:00:00 2001
From: Yunhao Meng <yunhao.meng@outlook.com>
Date: Fri, 3 Oct 2025 20:24:10 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0README.md=EF=BC=8C=E6=B7=BB?=
 =?UTF-8?q?=E5=8A=A0=E8=BF=90=E8=A1=8C=E8=AF=B4=E6=98=8E=E5=92=8C=E5=BE=85?=
 =?UTF-8?q?=E5=8A=9E=E4=BA=8B=E9=A1=B9=E5=88=97=E8=A1=A8?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index bbb062f..321936f 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,24 @@
 # fed-yolo
 
-Combine Federated Learning with YOLOv11.
\ No newline at end of file
+Combine Federated Learning with YOLOv11.
+
+## requirements
+```bash
+pip install -r requirements.txt
+```
+
+## how to run
+```bash
+nohup python fed_run.py > train.log 2>&1 &
+```
+
+## results
+
+## TODO
+- Add more FL algorithms (e.g., FedProx, FedAvgM, etc.)
+    - Implement FedProx
+    - Implement SCAFFOLD
+    - Implement FedNova
+- Add more YOLO versions (e.g., YOLOv8, YOLOv5, etc.)
+    - Implement YOLOv8
+    - Implement YOLOv5
\ No newline at end of file