Skip to content

Commit 0cff47a

Browse files
committed
add windows dev guidance
1 parent d1e2d5f commit 0cff47a

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ We are actively seeking additional maintainers. If you're interested, please ope
1212
poetry install
1313
```
1414

15+
### Windows
16+
17+
There is a symbolic link to the top level examples directory in tests. On Windows to make sure this link is created you need to be in developer mode and to configure git to allow symbolic links:
18+
19+
```console
20+
git config core.symlinks true
21+
```
22+
1523
## Documentation
1624

1725
`django-typer` documentation is generated using [Sphinx](https://www.sphinx-doc.org) with the [furo](https://github.com/pradyunsg/furo) theme. Any new feature PRs must provide updated documentation for the features added. To build the docs run doc8 to check for formatting issues then run Sphinx:

0 commit comments

Comments
 (0)