docs: fix Windows clone paths and installation instructions
check / validate (push) Canceled after 0s

This commit is contained in:
2026-10-19 14:06:52 +00:00
parent 215c5cea44
commit 9ed6df6173
+26 -4
View File
@@ -7,10 +7,13 @@ Windows installer manages the same Vim configuration.
- Git
- Vim 9 or newer
- Python 3 (Windows installer)
- Optional: tmux, zoxide, ripgrep, and a Nerd Font
## Install
### Linux, WSL, and macOS (Bash)
Clone the repository, then install all components:
```bash
@@ -29,10 +32,22 @@ The installer backs up conflicting files, creates managed links, and installs
Vim plugins. It does not install zoxide; if zoxide is already available, the
managed Bash block initializes it.
On Windows, clone the repository and run:
### Windows (PowerShell)
Clone into your user directory, then run the Windows installer:
```powershell
python .\win-install.py
git clone https://git.justconn.top/gitea-admin/dotfiles.git "$HOME\.dotfiles"
python "$HOME\.dotfiles\win-install.py"
```
Use `$HOME` explicitly in PowerShell: `~` passed to external commands such as
Git may be treated as a literal directory name instead of your user directory.
In Command Prompt (CMD), use `%USERPROFILE%` instead:
```cmd
git clone https://git.justconn.top/gitea-admin/dotfiles.git "%USERPROFILE%\.dotfiles"
python "%USERPROFILE%\.dotfiles\win-install.py"
```
## Vim
@@ -58,14 +73,21 @@ Plugin maintenance is explicit:
## Update and uninstall
Update safely from a clean worktree:
On Linux, WSL, and macOS, update safely from a clean worktree:
```bash
git -C ~/.dotfiles pull --ff-only
~/.dotfiles/install.sh
```
To remove managed links and the managed Bash block:
On Windows, update from a clean worktree in PowerShell:
```powershell
git -C "$HOME\.dotfiles" pull --ff-only
python "$HOME\.dotfiles\win-install.py"
```
On Linux, WSL, and macOS, remove managed links and the managed Bash block with:
```bash
~/.dotfiles/install.sh uninstall