Skip to content

Document setup on Windows #190

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document setup on Windows #190

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions docs-src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,24 @@ layout: default

First, prepare your system by taking a look at the [GTK installation page](https://www.gtk.org/docs/installations/).

### Setup on Windows

On Windows, some Rust-specific steps are necessary:

1. If you haven't already, [install rustup](https://rustup.rs/)
2. [Install MSYS2](https://www.msys2.org/)
3. Open a cmd prompt (not MSYS2 terminal) and run these commands:

set PATH=C:\msys64\mingw64\bin;%PATH%;C:\msys64\usr\bin
set PKG_CONFIG_PATH=C:\msys64\mingw64\lib\pkgconfig
set RUSTUP_TOOLCHAIN=stable-x86_64-pc-windows-gnu

rustup toolchain install stable-x86_64-pc-windows-gnu
pacman -S pkg-config mingw-w64-x86_64-gcc mingw-w64-x86_64-gtk3

Now you should able to `cargo run` your Rust project.
Note that you need to setup the environment variables as above each time you start a new terminal.

## Crate API docs

- [**atk**](../docs/atk/)
Expand Down