English version

README.md

@@ -4,11 +4,21 @@ Convert UFW log file to csv.
 ## 緣起　Introduction
 在啟用[UFW（Uncomplicated Firewall）](https://zh.wikipedia.org/wiki/Uncomplicated_Firewall)後有時候會打開防火牆產生的日誌看看，但看幾次總覺得原生出來的不太容易閱讀或統計之類的，因此動手寫了一個小程式來幫忙轉成csv。
 
+Why I create this little tool?
+
+Since using [UFW（Uncomplicated Firewall）](https://zh.wikipedia.org/wiki/Uncomplicated_Firewall) , I often check the diary(record)generated from the firewall. 
+However I find that it’s hard to read or to calculate the original diary(record)
+Thus, I decide to make a tool to translate the record to csv file.
+
 ## 需求　Requirements
 Python 3.6 以上或更新（Python2使用者可將程式碼中的兩個`, encoding='UTF-8'`刪掉亦可執行和輸出csv）
 
 Python 3.6 or or latest version (For Python2, you can delete `, encoding='UTF-8'` from code to execute.)
 
+The user has to use version 3.6 of Python or the latest one.
+if you use the version 2.
+Just delete the code “encoding='UTF-8”, and you can run the tool and output the csv file.
+
 ## 使用說明　Manual
 ※關於紀錄中各項目代表的意思可參見 https://askubuntu.com/questions/1116145/understanding-ufw-log 。 
 請將`ufw_log_to_csv.py`和`ufw.log`放在同個目錄下（可將log複製出來或將`ufw_log_to_csv.py`放進去，推薦前者）後執行： 
@@ -19,21 +29,50 @@ Python 3.6 or or latest version (For Python2, you can delete `, encoding='UTF-8'
 
 之後程式會自己尋找`ufw.log`這個檔案並輸出成`[YYYYMMDD_HHMMSS].csv`（可自行替換程式碼中輸出和輸入的檔名以符合自己需求），如果有不正確的地方請調整設定：編碼為**UTF-8**、資料有標題、分隔符號為**逗號**。
 
+About the meanings in every item, check https://askubuntu.com/questions/1116145/understanding-ufw-log 
+ plz put `ufw_log_to_csv.py`and `ufw.log`in the same catalog(copy log or put `ufw_log_to_csv.py`in, I RECOMMAND the former) to execute.
+ cd [檔案所在位置]
+ py ufw_log_to_csv.py # Windows user
+ python3 ufw_log_to_csv.py # Linux user
+
+and then the code will search `ufw.log` and export to `[YYYYMMDD_HHMMSS].csv`(you can change the name of the file to meet your need )
+if there is something unproper, plz debug in the following way： code is **UTF-8**、data with title and semicolon to **comma**.
 ## 常見Q&A
-1. Q：如果遇到`ValueError: dict contains fields not in fieldnames: 'something'`錯誤該怎麼辦？ 
-A：此情況代表該筆紀錄中出現了程式碼中沒有的欄位，請將錯誤紀錄及該筆原始 log 貼至 [issues](https://github.com/hms5232/ufw-log-to-csv/issues) 上以利更新程式。
-2. Q：輸出的 csv 欄位順序我不喜歡，可以自己改嗎？ 
-A：可以，請自行調整 `fieldnames` 此處的順序。但請注意，不要隨意更動欄位名稱以防程式出錯。
-3. Q：為什麼紀錄的最後方會有很多空的欄位？ 
-A：因為不同等級設定甚至是封包協定都會有不同的內容，為了方便篩選、統計等故全部列出。有資料則填入；沒有則留空。
-4. Q：「??」欄位是做什麼用的？如果有資料該怎麼辦？ 
-A：這個欄位是用於中括號裡紀錄的例外處理，如果此欄位出現資料，請將該筆原始紀錄回報至 [issues](https://github.com/hms5232/ufw-log-to-csv/issues)。
+Q1：如果遇到`ValueError: dict contains fields not in fieldnames: 'something'`錯誤該怎麼辦？ 
+A1：此情況代表該筆紀錄中出現了程式碼中沒有的欄位，請將錯誤紀錄及該筆原始 log 貼至 [issues](https://github.com/hms5232/ufw-log-to-csv/issues) 上以利更新程式。
+
+Q1:If you face the problem that "ValueError: dict contains fields not on fieldnames:'something'," how can you do?
+
+A1:This situation means the code get the columns that doesn't exist originally. Plz paste the wrong record and the original log to [issues](https://github.com/hms5232/ufw-log-to-csv/issues), so that the code can be updated.
+
+Q2：輸出的 csv 欄位順序我不喜歡，可以自己改嗎？ 
+A2：可以，請自行調整 `fieldnames` 此處的順序。但請注意，不要隨意更動欄位名稱以防程式出錯。
+
+Q2:I DON'T like the order of column in the csv file I output, may I take a change? 
+
+A2: Ya! please check the order in fieldnames and make sure that don't move the name of colmns. Or it may be wrong.
+
+Q3：為什麼紀錄的最後方會有很多空的欄位？ 
+A3：因為不同等級設定甚至是封包協定都會有不同的內容，為了方便篩選、統計等故全部列出。有資料則填入；沒有則留空。
+
+Q3:WHY there will some bank colmns on the bottom of the record?
+
+A3:Cause there are different sets and content for the protocol. To be easier to calculate and filter , I design the code to list all data. 
+If there is data, fill it in ;if not, leave it bank. 
+
+Q4：「??」欄位是做什麼用的？如果有資料該怎麼辦？ 
+A4：這個欄位是用於中括號裡紀錄的例外處理，如果此欄位出現資料，請將該筆原始紀錄回報至 [issues](https://github.com/hms5232/ufw-log-to-csv/issues)。
+
+Q4: What does [??] coilmn here? what can you do if there is data?
+
+A4: This column is for the exception of the record in brackets. If there is data, plz report that data to [issues](https://github.com/hms5232/ufw-log-to-csv/issues)。.
 
 ## 已知問題　Known issues
-1. 當協定為ICMP時有奇怪的紀錄會破壞整個邏輯，詳細見 [issue4](https://github.com/hms5232/ufw-log-to-csv/issues/4)
+1. 當協定為ICMP時有奇怪的紀錄會破壞整個邏輯，詳細見 [issue4](https://github.com/hms5232/ufw-log-to-csv/issues/4o
 
+1.When protocol is ICMP with strange recod, it will break whole logic. Read detail in [issue4](https://github.com/hms5232/ufw-log-to-csv/issues/4o
 
 ## 許可　License
 請見 [LICENSE](https://github.com/hms5232/ufw-log-to-csv/blob/master/LICENSE) 頁面。
- 
+
 See [LICENSE](https://github.com/hms5232/ufw-log-to-csv/blob/master/LICENSE).