GitHub/Anki
1
0
Fork 0
mirror of https://github.com/ankitects/anki.git synced 2026-01-09 12:03:56 -05:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

Format markdown files with dprint

Browse source
This commit is contained in:
Daniela Silva 2025-12-16 00:48:22 -03:00
parent 45574f2b82
commit 210fb084cc
1 changed files with 18 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docs/windows.md
View file

@ -20,7 +20,7 @@ Anki uses the **Rust programming language** for parts of its codebase.
2. Download and install **rustup** 2. Download and install **rustup**
3. During installation, accept the default options 3. During installation, accept the default options
> **Windows ARM users** > **Windows ARM users**\
> After installing rustup, run the following command in a terminal, inside the project folder: > After installing rustup, run the following command in a terminal, inside the project folder:
> >
> ```bash > ```bash
@ -34,11 +34,11 @@ Anki uses the **Rust programming language** for parts of its codebase.
1. Download **Visual Studio Community Edition** 1. Download **Visual Studio Community Edition**
2. Open the installer 2. Open the installer
3. Select: 3. Select:
- **Desktop Development with C++** - **Desktop Development with C++**
4. Leave the advanced options unchanged 4. Leave the advanced options unchanged
> **Note** > **Note**\
> This step is required to compile native parts of the project. > This step is required to compile native parts of the project.
--- ---
@ -67,7 +67,7 @@ C:\msys64\usr\bin
4. Reboot your computer 4. Reboot your computer
> **Important note** > **Important note**\
> If you already use **Git for Windows** (for example, [posh-git](https://github.com/dahlbyk/posh-git) in PowerShell), it may conflict with the MSYS2 Git. > If you already use **Git for Windows** (for example, [posh-git](https://github.com/dahlbyk/posh-git) in PowerShell), it may conflict with the MSYS2 Git.
> >
> - Prefer using [Git for Windows](https://gitforwindows.org/) > - Prefer using [Git for Windows](https://gitforwindows.org/)
@ -79,15 +79,17 @@ C:\msys64\usr\bin
To avoid build issues: To avoid build issues:
- Avoid long directory paths - Avoid long directory paths
- Avoid spaces in folder names - Avoid spaces in folder names
**Recommended**:
**Recommended**:
```text ```text
C:\anki C:\anki
``` ```
**Problematic**: **Problematic**:
```text ```text
C:\Users\Your Name\Documents\Projects\Anki Source Code C:\Users\Your Name\Documents\Projects\Anki Source Code
``` ```
@ -105,13 +107,16 @@ To play and record audio during development, ensure the following executables ar
## Common Problems ## Common Problems
### Build errors ### Build errors
- Make sure Visual Studio was installed with **Desktop Development with C++** - Make sure Visual Studio was installed with **Desktop Development with C++**
### `git` command not found ### `git` command not found
- Verify that the PATH variable is configured correctly - Verify that the PATH variable is configured correctly
### Issues caused by spaces in paths ### Issues caused by spaces in paths
- Move the project to a shorter path, such as `C:\anki` - Move the project to a shorter path, such as `C:\anki`
--- ---
@ -124,6 +129,5 @@ For advanced topics such as running tests or building wheels, see:
--- ---
> **Note** > **Note**\
> This guide does not replace the official documentation. It is intended to make the first steps easier for new Anki contributors on Windows. > This guide does not replace the official documentation. It is intended to make the first steps easier for new Anki contributors on Windows.