update README and environment documents

yuhao-kuo · Sep 13, 2024 · db8d4a5 · db8d4a5
1 parent 0f488ac
commit db8d4a5
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 27 deletions.
diff --git a/Chapters/enviornment.tex b/Chapters/enviornment.tex
@@ -2,7 +2,7 @@ \chapter{編輯環境} \label{ch_enviornment}
 
 本章描述使用專案時需要環境設定。本章節分為作業系統說明、CLI 以及 Docker。
 NKUST-latex-template 編譯環境僅需由 CLI 和 Docker 之中擇一即可。
-本專案僅需要基礎的文字編輯器 vi、emase、notepad 等搭配 command line 即可使用，但我們推薦使用 VSCode 進行編輯，能讓您有較舒適的整合性使用體驗。
+本專案僅需要基礎的文字編輯器 vi、emase、notepad 等搭配 command line 即可使用，但我們推薦使用 VSCode 進行編輯，能讓您有較舒適的使用體驗。
 
 \section{Windows環境說明}
 
@@ -39,18 +39,10 @@ \section{Docker}
 
 \begin{itemize}
         \item 本專案的論文主體請存放於 host\footnote{附註：Host 系統指的是您 Docker 安裝的基底系統，正常情況下是 Windows、Linux 或是 MacOS，如果 Docker 是安裝於 WSL2 中，這個 Host 指的是 WSL2。} 系統中，Docker image 啟動時會自動將您的論文目錄掛載到 container 中。
-        \item 當 container 被關閉時，除論文目錄以外的 container 的資料都會被抹除。如要有須保留 container 資料請在 \emph{docker run} 的啟動參數中移除 $--$rm 即可。
+        \item 當 container 被關閉時，除論文目錄以外的 container 的資料都會一起被關閉。
 \end{itemize}
 
-Docker 安裝請參閱官方文件。
-
-\begin{itemize}
-        \item Windows\cite{win_docker}
-        \item Linux\cite{linux_docker}
-        \item MacOS\cite{mac_docker}
-\end{itemize}
-
-\newpage
+Docker 安裝請參閱官方文件。Windows\cite{win_docker}、Linux\cite{linux_docker}、MacOS\cite{mac_docker}。
 
 \subsection{Bash}
 

diff --git a/Docs/docker.md b/Docs/docker.md
@@ -6,7 +6,7 @@
 
 論文主體存在於 host 系統中，開機時會自動把 host 中的 NKUST-thesis-template 掛載到 Container 上。可利用 vscode remote development extension 等編輯器進行遠端編輯與編譯。
 
-當 container 被關閉時，除論文目錄以外的 container 的資料都會被抹除。如要有須保留 container 資料請在 `docker run` 的啟動參數中移除 `--rm` 即可。
+當 container 被關閉時，除論文目錄以外的 container 的資料都會被抹除。
 
 ## 環境佈署
 

diff --git a/Docs/environment.md b/Docs/environment.md
@@ -8,7 +8,7 @@
 
 > Overleaft 環境是由 [fuanho](https://github.com/fuanho) 維護的 [NKUST-Thesis-template-overleaf](https://github.com/fuanho/NKUST-Thesis-template-overleaf) 專案提供，使用此方案者不需要額外安裝套件。
 
-> 下列圖示以 CLI 來標示 **CLI 環境**，以 Docker 來標示 **Docker** 環境。
+> 下列圖示以 CLI 來標示的為 **CLI 環境**，以 Docker 圖示來標示的為 **Docker** 環境。
 
 #### **[Visual Studio Code](https://code.visualstudio.com/)**
 
@@ -94,7 +94,7 @@ $ sudo apt install texlive-full
 
 非必要的工具，目前僅用於 PDF 檔案防拷。
 
-> Linux 與 Docker 方案的使用者，此工具不須安裝。
+> Linux 與 Docker 方案的使用者，此工具已內建於系統中，不須額外安裝。<br>
 > Windows 系統使用者如有 Adobe 的工具，建議直接使用 Adobe 工具即可。
 
 請由此處[下載](https://www.ghostscript.com/releases/index.html)。
diff --git a/Instance/acknowledgement.tex b/Instance/acknowledgement.tex
@@ -4,5 +4,6 @@
 \addchaptertocentry{\acknowledgementname}
 \begin{acknowledgements}
 
-謝謝天~ 謝謝地~ 謝謝蜂蜜檸檬！
+謝謝 WNDCLab、NCLab、AIoRLab 的前輩以及 GitHub 上貢獻者的努力，共同維護這份模板，讓更多人使用，感謝大家的貢獻！
+
 \end{acknowledgements} 
diff --git a/README.md b/README.md
@@ -8,13 +8,13 @@
 
 ![](https://www.nkust.edu.tw/var/file/0/1000/img/513/182513897.png)
 
-本專案為**國立高雄科技大學研究所論文 LaTeX 模板**，以開源工具為基礎 LaTeX 的編輯環境，內文依照[國立高雄科技大學教務處學位論文撰寫體例參考(中華民國111年3月修訂版)](https://acad.nkust.edu.tw/var/file/4/1004/img/212/F-2-35.docx)及建工校區電子工程系網路計算實驗室(`WNDCLab`、`NCLab`、`AIoRLab`)之論文格式標準進行編排。其內容排列順序依序為：
+本專案為**國立高雄科技大學研究所論文 LaTeX 模板**，以開源工具為基礎的 LaTeX 編輯環境，內文依照[國立高雄科技大學教務處學位論文撰寫體例參考(中華民國111年3月修訂版)](https://acad.nkust.edu.tw/var/file/4/1004/img/212/F-2-35.docx)及建工校區電子工程系網路計算實驗室(`WNDCLab`、`NCLab`、`AIoRLab`)之論文格式標準進行編排。其內容排列順序依序為：
 
 1. 封面
 2. 書名頁
-3. 論文指導教授推薦書
-4. 論文口試委員會審訂書
-5. 學位論文著作權歸屬協議書
+3. 論文指導教授推薦書 (自行置入)
+4. 論文口試委員會審訂書 (自行置換)
+5. 學位論文著作權歸屬協議書 (自行置換)
 6. 中文摘要
 7. 英文摘要
 8. 誌謝或序言
@@ -49,7 +49,10 @@
 
 請直接下載[穩定版本](https://github.com/yuhao-kuo/NKUST-thesis-template/releases)/[開發版本](https://github.com/yuhao-kuo/NKUST-thesis-template/archive/master.zip)，或是使用 git 獲取專案。
 
-開發版本主要著重在新功能的開發及新的支援，但是當您的論文撰寫時間較為緊迫，我們建議使用穩定版本。
+> 建議使用 Git 獲取專案
+
+開發版本為 master 分支中的最新版本，穩定版本是架構或內容經過大變動後的版本。目前論文架構已經趨近穩定，已經少有劇烈的變動，因此直接下載開發版本即可。
+
 使用時發現任何問題，歡迎向我們發出 Issues 並描述您碰見的問題。
 
 ### 使用
@@ -77,7 +80,7 @@
 * ***thesisinfo.tex*** : 論文作者訊息
 * ***titlepage.tex*** : 置中的論文封面
 
-因字體問題經常導致使用者在編譯時出現錯誤，基於易用原則在本次更新中重新將 Fonts 加入至專案中，Fonts 內提供的字體皆為**開源** or **免費**的，字體的 License 將一併被附加到 Fonts 目錄中。
+字體問題經常導致編譯時出現錯誤，基於易用原則在 [Release v2.0](https://github.com/yuhao-kuo/NKUST-thesis-template/releases/tag/v2.0) 重新將 Fonts 加回專案中，Fonts 內提供的字體皆為**開源** or **免費**的，字體的 License 一併被附加到 Fonts 目錄中。
 
 #### 產生論文
 
@@ -89,7 +92,7 @@ $ make all
 
 #### 資料清除
 
-清除暫存資料請使用 `clean`，該指令將會保留 PDF 文件，如需完整清除編譯結果請使用 `distclean`。
+清除暫存資料請使用 `clean`，該指令將會保留編譯時產生的 PDF 文件，如需完整清除編譯結果請使用 `distclean`。
 
 ```
 $ make clean
@@ -98,16 +101,16 @@ $ make distclean
 
 #### 檔案防拷處理
 
-因有論文 PDF 加入防拷處理的需求，故新增 `pdfprocessing`，此功能依賴外部工具 **ghostscript**。
-該命令僅對 `main.pdf` 進行防拷，執行此命令時 `main.pdf` 必須存在。
+考量到論文 PDF 有加入防拷處理的需求，故新增指令 `pdfprocessing`，此功能依賴外部工具 **ghostscript**。
+該命令僅對 `main.pdf` 進行防拷處理，因此執行命令時 `main.pdf` 必須存在。
 
 ```
 $ make pdfprocessing
 ```
 
 ## 安全性
 
-如使用 GitHub、GitLab、Bitbucket 等程式碼代管服務，請注意遠端儲存庫 (Remote Repository) 的存取權限，知識內容請設為私密，以避免防資料外洩等安全性問題。
+如使用 **GitHub**、**GitLab**、**Bitbucket** 等公開的程式碼代管服務管理論文，請注意遠端儲存庫 (Remote Repository) 的存取權限，知識內容請設為私密，以避免防資料外洩等安全性問題。
 
 ## 鳴謝
 

diff --git a/build/main.pdf b/build/main.pdf
diff --git a/build/main_encpy.pdf b/build/main_encpy.pdf
diff --git a/build/titlepage.pdf b/build/titlepage.pdf
diff --git a/thesisinfo.tex b/thesisinfo.tex
@@ -36,8 +36,8 @@
 \def\titleen{NKUST LaTeX Thesis Template}
 
 % 日期(月份)
-\def\dateROC{中華民國 一一一 年 六 月}
-\def\dateen{Jun, 2022}
+\def\dateROC{中華民國 一一四 年 六 月}
+\def\dateen{Jun, 2025}
 
 % pdf search keywords
 \def\thesiskeywords{{LaTeX},{NKUST},{Thesis},{Template}}