Skip to content

Commit

Permalink
Change CONTRIBUTING.md to avoid UTF-16 encoding issue
Browse files Browse the repository at this point in the history
  • Loading branch information
escritorio-gustavo committed Jan 23, 2024
1 parent 2da9e6e commit d05e5f0
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.


Expand All @@ -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`.
To ensure proper formatting, please run `cargo +nightly fmt`.

0 comments on commit d05e5f0

Please sign in to comment.