jan/snarled
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

add caveats to readme

Browse source
This commit is contained in:
jan 2022-04-01 17:41:56 -07:00
commit 7bbed0bc28
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -106,4 +106,11 @@ Open nets:
- Useful classes, namely `NetsInfo` and `NetName`, are in `snarled.tracker`.
- `snarled.interfaces` contains helper code for interfacing with other packages.
## Caveats
This package is slow, dumb, and the code is ugly. There's only a basic test case.
If you know what you're doing, you could probably do a much better job of it.
...but you *have* heard of it :)