From 4c5c194847d4800f5ed7c060a388c142b877bfd4 Mon Sep 17 00:00:00 2001 From: escritorio-gustavo <131818645+escritorio-gustavo@users.noreply.github.com> Date: Tue, 23 Jan 2024 12:17:52 -0300 Subject: [PATCH] Change CONTRIBUTING.md to avoid UTF-16 encoding issue (#201) --- CONTRIBUTING.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f1d62df..485516b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,8 +3,14 @@ If you are unsure what to work on or want to discuss your idea, feel free to ope ### Documentation After implementing a new feature, please document it in the doc comment on `TS` in `ts_rs/lib.rs`. -`README.md` is generated from the module doc comment in `ts_rs/lib.rs`. If you added/updated documentation there, run -`cargo readme > ../README.md` from the `ts-rs/` directory. +`README.md` is generated from the module doc comment in `ts_rs/lib.rs`. If you added/updated documentation there, go to the `ts-rs/` directory and run one of the following commands: + +On Windows: +`cargo readme -o ..\README.md` + +On other systems: +`cargo readme > ../README.md` + You can install `cargo readme` by running `cargo install cargo-readme`. @@ -16,4 +22,4 @@ There is nothing special going on here - just run `cargo build`. To run the test suite, just run `cargo test` in the root directory. ### Formatting -To ensure proper formatting, please run `cargo +nightly fmt`. \ No newline at end of file +To ensure proper formatting, please run `cargo +nightly fmt`.