Skip to content

Commit fd8d118

Browse files
committed
Add some developer notes
1 parent 8ebd275 commit fd8d118

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@ synced from the `mypyc/lib-rt`
1212

1313
Report any issues in the [mypyc issue tracker](https://github.com/mypyc/mypyc/issues).
1414

15+
## Developer notes
16+
17+
Since this repo should be kept in sync with `mypy`, it has an unusual directory structure.
18+
If you want to install from sources, it is recommended to use `sdist` wheel. If you want to
19+
install directly form the repo, you will need to execute `cp -r lib-rt/* .` before install.
20+
See issue #17 for discussion.
21+
22+
Unfortunatelly PyPy is not supported. If you develop a library that supports PyPy and you need
23+
`librt` only as a `mypy` dependency, you can skip PyPy in your CI matrix when type checking
24+
(since results of type checking will be identical on e.g. CPython 3.11 and PyPy 3.11).
25+
See issue #16 for discussion.
26+
1527
## Making a release
1628

1729
1. As a prerequisite, there generally will be some changes in the mypy repository under `mypyc/lib-rt`

0 commit comments

Comments
 (0)