Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add windows encoding note #50

Merged
merged 3 commits into from
Feb 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,8 @@ zig build test_examples
```

### Troubleshooting
If Zig doesn't detect changes in a dependency, clear the project's `zig-cache` folder and `~/.cache/zig`.
- If Zig doesn't detect changes in a dependency, clear the project's `zig-cache` folder and `~/.cache/zig`.
- [Non-ASCII characters not printed correctly on Windows](docs/advanced.md)

## Contributing

Expand Down
16 changes: 14 additions & 2 deletions docs/advanced.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
### Advanced
## Advanced

TODO
### Note for Windows Users

If you encounter issues with character encoding, such as misrepresentation of "plusminus" (±) or "sigma" (σ) symbols in the benchmark results, it's likely due to Windows using UTF-16 LE encoding by default. To ensure characters are displayed correctly, you can switch your system to use UTF-8 encoding by following these steps:

1. Open **Control Panel**.
2. Navigate to **Region** > **Administrative** tab.
3. Click on **Change system locale...**.
4. Check the option for **Beta: Use Unicode UTF-8 for worldwide language support**.
5. Click **OK** and restart your computer if prompted.

This setting will configure your system to use UTF-8 encoding for non-Unicode programs, which should resolve any character display issues in the benchmark output.

[Zig console output encoding issue](https://github.com/ziglang/zig/issues/7600#issuecomment-753563786)
Loading