Skip to content

Commit bfd8d23

Browse files
fix: clean up Windows setup guide and fix linting errors
1 parent ce0ed40 commit bfd8d23

1 file changed

Lines changed: 38 additions & 36 deletions

File tree

WINDOWS_SETUP.md

Lines changed: 38 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,90 @@
1-
Windows Setup Guide
1+
# Windows Setup Guide
22

3-
To get setup for development on Windows, see
4-
[this video if you prefer VS Code](https://youtu.be/zddl3n1DCFM),
5-
or [this older video if you prefer PyCharm](https://youtu.be/QniQi-Hoo9A),
3+
To get setup for development on Windows, see
4+
[this video if you prefer VS Code](https://youtu.be/zddl3n1DCFM),
5+
or [this older video if you prefer PyCharm](https://youtu.be/QniQi-Hoo9A),
66
and the instructions below.
77

8-
1. Fork and clone this repo
9-
10-
Go to https://github.com/malariagen/malariagen-data-python
11-
and click the Fork button (top right corner).
12-
13-
Then in PowerShell run:
8+
## 1. Fork and clone this repo
149
```bash
1510
git clone https://github.com/[username]/malariagen-data-python.git
1611
cd malariagen-data-python
1712
```
1813

19-
2. Install Python
14+
## 2. Install Python
2015

21-
Download and install Python 3.10 from:
16+
Download and install Python 3.10 from the official website:
2217
https://www.python.org/downloads/windows/
2318

24-
> ⚠️ Important: During installation, check the box
25-
> "Add Python to PATH" before clicking Install.
19+
During installation, check the box that says Add Python to PATH
20+
before clicking Install.
2621

27-
Verify it worked:
22+
Verify the installation worked:
2823
```bash
2924
python --version
3025
```
3126

32-
3. Install pipx and poetry
27+
## 3. Install pipx and poetry
3328
```bash
3429
python -m pip install --user pipx
3530
python -m pipx ensurepath
3631
pipx install poetry
3732
```
3833

39-
> ⚠️ After running ensurepath, close and reopen
40-
> PowerShell before continuing.
34+
After running ensurepath, close and reopen PowerShell before continuing.
4135

42-
4. Create and activate development environment
36+
## 4. Create and activate development environment
4337
```bash
4438
poetry install
4539
poetry shell
4640
```
4741

48-
5. Install pre-commit hooks
42+
## 5. Install pre-commit hooks
4943
```bash
5044
pipx install pre-commit
5145
pre-commit install
5246
```
5347

54-
6. Add upstream remote and get latest code
48+
## 6. Add upstream remote and get latest code
5549
```bash
5650
git remote add upstream https://github.com/malariagen/malariagen-data-python
5751
git pull upstream master
5852
```
5953

60-
> ℹ️ Note: On Windows the default branch is called
61-
> master not main.
54+
Note: On Windows the default branch is called master, not main.
6255

63-
7. Verify everything works
56+
## 7. Verify everything works
6457
```bash
6558
python -c "import malariagen_data; print('Setup successful!')"
6659
```
6760

68-
Common Issues on Windows
61+
## Common Issues on Windows
62+
63+
**poetry not found after install**
6964

70-
poetry not found after install
7165
Close and reopen PowerShell, then try again.
7266

73-
git not recognized
74-
Install Git from https://git-scm.com/download/win
67+
**git not recognized**
68+
69+
Install Git from https://git-scm.com/download/win
7570
and restart PowerShell.
7671

77-
python not recognized
78-
Reinstall Python and make sure to check
79-
"Add Python to PATH" during installation.
72+
**python not recognized**
73+
74+
Reinstall Python and make sure to check
75+
Add Python to PATH during installation.
76+
77+
**fatal: not a git repository**
8078

81-
fatal: not a git repository
82-
Make sure you are inside the malariagen-data-python
79+
Make sure you are inside the malariagen-data-python
8380
folder before running any git commands.
84-
Use: cd malariagen-data-python
81+
```bash
82+
cd malariagen-data-python
83+
```
84+
85+
**error: pathspec main did not match**
8586

86-
error: pathspec main did not match
8787
On Windows use master instead of main.
88-
Run: git checkout master
88+
```bash
89+
git checkout master
90+
```

0 commit comments

Comments
 (0)