mirrors/anki
2
0
Fork 0
mirror of https://github.com/ankitects/anki.git synced 2026-09-10 08:39:22 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
fix/remove-comment-issue-example
anki/docs/windows.md
Luc Mcgrady 7cf1d29896 docs: Replace docs/ with symlinks (#5031) 
<!--
Title (for the Pull Request title field at the top):
Use a short prefix so the change type is obvious. You do not need to
repeat it in the body below.

Examples:
- fix: — bugfix
- feat: — feature
- refactor: — internal change without user-facing feature
- docs: — documentation only
- chore: — tooling, CI, deps, build housekeeping
- test: — tests only
-->

## Linked issue (required)

<!-- Fixes #123 / Closes #123 / Refs #123 -->
closes #5001

This PR replaces the contents of `docs/` with symlinks to
`docs-site/developers/`

A caveat of this is that the metadata appears at the top of the file
instead of the title.
<img width="885" height="275" alt="image"
src="https://github.com/user-attachments/assets/430f9a71-e5a5-4412-983a-e4cfd7dc4714"
/>

We could either:
- Use ninja to copy the files from docs-site/developers and convert it
from .mdx to .md (Might be a problem with the symlink approach if mdx is
added to the contributor file later)
- Leave placeholder "For contribution instructions see: (link to
mintlify site)"s in the folder, which would have to wait until the
domain of the site is set. (Probably the best solution).

---------

Co-authored-by: Abdo <abdo@abdnh.net>
2026-08-04 22:01:31 +03:00

2.5 KiB
Raw Permalink Blame History

Windows

Minimum Requirements

  • 64-bit Windows 10 (version 1703 or newer)
  • Administrator access to install software

Install Rust

  1. Visit the official Rust website (https://rustup.rs/)
  2. Download and install rustup
  3. During installation, accept the default options

Note

The Rust installer will offer to automatically download and install the required MSVC build tools. If you prefer a minimal install without the full Visual Studio IDE, do the following before installing Rust:

  1. Install Visual Studio Build Tools via winget: 
    winget install Microsoft.VisualStudio.BuildTools
  2. Open the Visual Studio Installer, select Build Tools, click Modify, then under Individual components, install:
    • MSVC Build Tools for x64/x86 (Latest)
    • Windows 11 SDK (or Windows 10 SDK if you're on Windows 10)

Then proceed with the Rust installation above.

Important

Windows ARM users: After installing rustup, run the following command in a terminal, inside the project folder:

rustup target add x86_64-pc-windows-msvc

Install MSYS2

  1. Visit the MSYS2 website
  2. Install it in the default location
  3. After installation, open the MSYS2 UCRT64 terminal
  4. Run the following command:
pacman -S git rsync

Configure the PATH environment variable

  1. Search for and open Edit the system environment variables in the Start menu
  2. Click Environment Variables
  3. Edit the Path variable under System Variables
  4. Add the following path then reboot your computer: C:\msys64\usr\bin

Note

If you have native Windows apps relying on Git, e.g. the PowerShell extension posh-git, you may want to install Git for Windows and put it on the path instead, as msys Git may cause issues with them. You'll need to make sure rsync is available some other way.

Choose a good source code location

Anki's source files do not need to be in a specific location, but it's best to avoid long paths, as they can cause problems. Spaces in the path may cause problems.

More

For info on running tests, building wheels and so on, please see Development.