20240522 update

rust-cli · May 21, 2024 · a05989e · a05989e
1 parent a96bffb
commit a05989e
Show file tree

Hide file tree

Showing 42 changed files with 11 additions and 19 deletions.
diff --git a/src/README.md b/src/README.md
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
diff --git a/src/in-depth/README.md b/src/in-depth/README.md
diff --git a/src/in-depth/config-files.md b/src/in-depth/config-files.md
diff --git a/src/in-depth/docs.md b/src/in-depth/docs.md
@@ -1,13 +1,10 @@
 # 為你的 CLI 程式產生文件 
 
-CLI 的文件 通常包括指令中的 `--help` 部分和一個手冊（`man`）頁面。
+CLI 程式的文件 通常會包括指令中的 `--help` 部分和一個手冊（`man`）頁面。
 
-Both can be automatically generated
-when using [`clap`](https://crates.io/crates/clap), via
-[`clap_mangen`](https://crates.io/crates/clap_mangen) crate.
-
-兩者都可以自動生成
-使用 [`clap`](https://crates.io/crates/clap) 時，透過[`clap_mangen`](https://crates.io/crates/clap_mangen) 箱。
+兩者都可以自動產生
+當使用 [`clap`](https://crates.io/crates/clap) 時，
+會透過 [`clap_mangen`](https://crates.io/crates/clap_mangen) crate。
 
 ```rust,ignore
 #[derive(Parser)]
@@ -20,16 +17,11 @@ pub struct Head {
 }
 ```
 
-Secondly, you need to use a `build.rs`
-to generate the manual file at compile time
-from the definition of your app
-in code.
+其次，您需要使用 `build.rs`在編譯時,
+請根據您的應用程式在程式碼中的定義而產生手冊文件。
 
-There are a few things to keep in mind
-(such as how you want to package your binary)
-but for now
-we simply put the `man` file
-next to our `src` folder.
+在這裡你要留意幾件事（例如如何打包你的程式）， 
+但現在我們只是簡單地把 `man` 檔案放到我們的 `src` 同等級目錄。
 
 ```rust,ignore
 use clap::CommandFactory;
@@ -57,4 +49,4 @@ in your project directory.
 
 If you open that in `man`
 you'll be able to admire your free documentation.
-如果你在 `man` 中打開它，則你可閱讀
+如果你在 `man` 中打開它，則你可閱讀文件
diff --git a/src/in-depth/exit-code.md b/src/in-depth/exit-code.md
diff --git a/src/in-depth/human-communication.md b/src/in-depth/human-communication.md
diff --git a/src/in-depth/machine-communication-stdin.rs b/src/in-depth/machine-communication-stdin.rs
diff --git a/src/in-depth/machine-communication-wc.rs b/src/in-depth/machine-communication-wc.rs
diff --git a/src/in-depth/machine-communication.md b/src/in-depth/machine-communication.md
diff --git a/src/in-depth/machine-communication.rs b/src/in-depth/machine-communication.rs
diff --git a/src/in-depth/signals-channels.rs b/src/in-depth/signals-channels.rs
diff --git a/src/in-depth/signals-ctrlc.rs b/src/in-depth/signals-ctrlc.rs
diff --git a/src/in-depth/signals-hooked.rs b/src/in-depth/signals-hooked.rs
diff --git a/src/in-depth/signals.md b/src/in-depth/signals.md
diff --git a/src/resources/README.md b/src/resources/README.md
diff --git a/src/special-content.css b/src/special-content.css
diff --git a/src/tutorial/README.md b/src/tutorial/README.md
diff --git a/src/tutorial/cli-args-clap.rs b/src/tutorial/cli-args-clap.rs
diff --git a/src/tutorial/cli-args-struct.rs b/src/tutorial/cli-args-struct.rs
diff --git a/src/tutorial/cli-args-vars.rs b/src/tutorial/cli-args-vars.rs
diff --git a/src/tutorial/cli-args.asciinema b/src/tutorial/cli-args.asciinema
diff --git a/src/tutorial/cli-args.md b/src/tutorial/cli-args.md
diff --git a/src/tutorial/cli-args.svg b/src/tutorial/cli-args.svg
diff --git a/src/tutorial/errors-custom.rs b/src/tutorial/errors-custom.rs
diff --git a/src/tutorial/errors-exit.rs b/src/tutorial/errors-exit.rs
diff --git a/src/tutorial/errors-impl.rs b/src/tutorial/errors-impl.rs
diff --git a/src/tutorial/errors.md b/src/tutorial/errors.md
diff --git a/src/tutorial/impl-draft-shortcut.rs b/src/tutorial/impl-draft-shortcut.rs
diff --git a/src/tutorial/impl-draft.md b/src/tutorial/impl-draft.md
diff --git a/src/tutorial/impl-draft.rs b/src/tutorial/impl-draft.rs
diff --git a/src/tutorial/output-log.rs b/src/tutorial/output-log.rs
diff --git a/src/tutorial/output-progressbar.rs b/src/tutorial/output-progressbar.rs
diff --git a/src/tutorial/output.md b/src/tutorial/output.md
@@ -156,7 +156,7 @@ writeln!(handle, "foo: {}", 42); // add `?` if you care about errors here
 有些 CLI 程式的運作時間很長，
 會花費幾分鐘甚至數小時。 
 如果你在編寫這種程式，
-你可能想要向使用者展示，其程式正在正常運作中。 
+你可能需要向使用者展示，其程式正在正常運作中。 
 因此，你需要輸出有用的狀態更新訊息，
 最好是使用易於使用的方式來進行輸出。
 

diff --git a/src/tutorial/packaging.md b/src/tutorial/packaging.md
diff --git a/src/tutorial/setup.asciinema b/src/tutorial/setup.asciinema
diff --git a/src/tutorial/setup.md b/src/tutorial/setup.md
@@ -13,7 +13,7 @@
 - `Cargo.toml` 裡包含了我們專案所有的中繼資料，包括我們使用依賴/外部函式庫列表。
 - `src/main.rs` 是我們程式的二進制入口檔案（主程式）。
 
-如果可以在`grrs`目錄下執行`cargo run`並得到一個“Hello World”，那你就已經準備好了。
+如果可以在`grrs`目錄下執行`cargo run`並得到一個 `Hello, World!`，那你就已經準備好了。
 
 ## 它可能會是什麼樣子
 

diff --git a/src/tutorial/setup.svg b/src/tutorial/setup.svg
diff --git a/src/tutorial/testing.md b/src/tutorial/testing.md
diff --git a/src/tutorial/testing/Cargo.toml b/src/tutorial/testing/Cargo.toml
diff --git a/src/tutorial/testing/src/main.rs b/src/tutorial/testing/src/main.rs
diff --git a/src/tutorial/testing/tests/cli.rs b/src/tutorial/testing/tests/cli.rs