Skip to content

Commit 24a0dfc

Browse files
committed
DOC: add Windows uvloop compatibility notice and Docker recommendation to README
1 parent b6f27b4 commit 24a0dfc

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@
1414
- [install mongodb-atlas](https://www.mongodb.com/try/download/community)
1515
- Install dependencies `python3 -m pip install -r requirements.txt`
1616

17+
### Windows Users
18+
⚠️ **Known Issue**: `uvloop` does not support Windows and will fail during pip installation with:
19+
```
20+
RuntimeError: uvloop does not support Windows at the moment
21+
```
22+
23+
**Recommended Solution**: Use Docker (easiest approach)
24+
1725
## Development
1826
- make format
1927
- make test

0 commit comments

Comments
 (0)