update readme

Author: Yauanyyy

BCJR_K3_75.c

@@ -1,19 +1,66 @@
 # 信道编码课程大作业 (Channel Coding Course Work)
 
-这是一个关于卷积码编码与 Viterbi 译码（硬判决/软判决）的 C 语言实现项目。
+![Build Status](https://github.com/Yauanyyy/InformationTheory/actions/workflows/run_simulation.yml/badge.svg)
+![Language](https://img.shields.io/badge/language-C%20%7C%20Python-blue.svg)
 
-## 📁 文件说明
+本项目是信道编码课程的大作业实现。主要包含 **(2,1,3) 卷积码** 的编码器以及基于 **Viterbi 算法** 的硬判决与软判决译码器的 C 语言实现。
 
-* `template.c`: 老师提供的原始代码模板。
-* `Viterbi_Hard_K3_75.c`: **当前主程序**。包含卷积编码器和**硬判决** Viterbi 译码器的实现。
-* `print_stateTABLE.c`: 一个辅助工具，用于打印和检查状态转移表 (State Table) 的逻辑是否正确。
-* `.gitignore`: 配置文件，用于忽略编译生成的 `.exe`, `.o` 等临时文件。
+## 📂 文件结构
 
-## ✅ 任务进度 (To-Do List)
+```text
+.
+├── Viterbi_Hard_K3_75.c      # 硬判决 Viterbi 仿真主程序
+├── Viterbi_Soft_K3_75.c      # 软判决 Viterbi 仿真主程序
+├── print_stateTABLE.c        # 状态转移表验证工具
+├── plot_new.py               # 自动化绘图脚本 (Python)
+├── .github/workflows/        # GitHub Actions 自动化配置
+├── zoutput/                  # 仿真数据输出目录 (.csv)
+└── pictures/                 # 结果图输出目录 (.png)
+```
 
-- [x] **编码器 (Encoder)**: 完成状态表生成与编码逻辑。
-- [x] **硬判决译码 (Hard Viterbi)**: 完成 Hamming 距离计算与回溯算法。
-- [x] **软判决译码 (Soft Viterbi)**: 需修改度量计算方式 (Euclidean distance)。
-- [x] **性能仿真 (Simulation)**: 导出 BER vs SNR 数据并绘图。
-- [ ] **(可选) BCJR**
-- [ ] **(可选) Turbo: 进阶任务。**
+## 🚀 快速开始 (How to Run)
+
+### 方式一：GitHub Actions (推荐)
+
+无需本地环境，直接在网页操作：
+
+1.  点击仓库上方 **Actions** -\> 选择 **Simulation and Plotting**。
+2.  点击 **Run workflow**。
+3.  运行结束后在 **Artifacts** 处下载结果（含 CSV 数据与高清对比图）。
+
+### 方式二：本地运行
+
+需要 GCC 与 Python 环境：
+
+```bash
+# 1. 编译
+gcc Viterbi_Hard_K3_75.c -o viterbi_hard -lm
+gcc Viterbi_Soft_K3_75.c -o viterbi_soft -lm
+
+# 2. 运行仿真 (示例: 0-10dB, 10000帧)
+# 使用 echo 自动输入参数: 起始SNR 终止SNR 帧数
+echo "0 10 10000" | ./viterbi_hard
+echo "0 10 10000" | ./viterbi_soft
+
+# 3. 绘图
+# 注意：请手动将生成的 .csv 移动至 zoutput/ 文件夹
+python plot_new.py
+```
+
+## 📊 仿真结果
+
+下图展示了 K=3, (7,5) 卷积码的性能对比（软判决相比硬判决约有 2dB 增益）：
+
+> *请运行仿真后查看 `pictures/` 目录下的结果图*
+
+## ✅ 任务进度
+
+  - [x] **编码器 (Encoder)**: 完成状态表生成与编码逻辑。
+  - [x] **硬判决译码 (Hard Viterbi)**: 完成 Hamming 距离计算与回溯。
+  - [x] **软判决译码 (Soft Viterbi)**: 完成 Euclidean 距离计算。
+  - [x] **自动化流水线**: GitHub Actions 自动编译绘图。
+  - [ ] **(可选) BCJR / Turbo 码**: 待进阶实现。
+
+-----
+
+*Created by ZZ, LSH, HZH*

README.md

@@ -1,5 +1,9 @@
 /***************************************************
-Channel Coding Course Work: Convolutional Codes (Soft Decision)
+Channel Coding Course Work: conolutional codes
+This program template has given the message generator, BPSK modulation, AWGN channel model and BPSK demodulation,
+you should first determine the encoder structure, then define the message and codeword length, generate the state table, write the convolutional encoder and decoder.
+ 
+If you have any question, please contact me via e-mail: liangjw59@mail2.sysu.edu.cn, or, yangzhj59@mail2.sysu.edu.cn.
 ***************************************************/
 
 #define  _CRT_SECURE_NO_WARNINGS

Viterbi_Soft_K3_75.c

@@ -7,7 +7,7 @@
 # ================= 风格配置区域 =================
 
 # 选项: "ACADEMIC", "MODERN", "PRESENTATION"
-STYLE_OPTION = "PRESENTATION"  
+STYLE_OPTION = "ACADEMIC"  
 
 # 路径配置
 csv_dir = "zoutput" 
@@ -17,7 +17,7 @@
 curves = {
     "Hard Decision Viterbi": "hard_viterbi.csv",
     "Soft Decision Viterbi": "soft_viterbi.csv",
-    # "BCJR": "bcjr.csv",
+    "BCJR": "bcjr_soft.csv",
     "Uncoded BPSK (Theory)": "theory"
 }
 
@@ -72,7 +72,7 @@ def plot_ber():
     markers = ['o', '^', 's', 'D', 'v', 'x']
 
     # --- 定义线型列表 (学术风可能需要实线虚线交替) ---
-    linestyles = ['-', '-', '-', '-'] 
+    linestyles = ['-', '--', '-', '--'] 
 
     idx = 0 # 用于轮询颜色和标记
 

pictures/ber_plot_academic.png

@@ -19,7 +19,7 @@
 curves = {
     "Hard Decision Viterbi": "hard_viterbi.csv",
     # "Soft Decision Viterbi": "soft_viterbi.csv", 
-    # "BCJR": "bcjr.csv",
+    # "BCJR": "bcjr_soft.csv",
     "Uncoded BPSK (Theory)": "theory"
 }
 

pictures/ber_plot_modern.png

@@ -0,0 +1,14 @@
+SNR,BER
+0.000000,8.755680E-02
+1.000000,3.991950E-02
+2.000000,1.376660E-02
+3.000000,3.497200E-03
+4.000000,6.481000E-04
+5.000000,8.080000E-05
+6.000000,6.400000E-06
+7.000000,4.000000E-07
+8.000000,0.000000E+00
+9.000000,0.000000E+00
+10.000000,0.000000E+00
+11.000000,0.000000E+00
+12.000000,0.000000E+00