diff --git a/README.md b/README.md index c26bf9d..07fc4f8 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ - `autoreload` must work with editable install of the dev version - Multiple dev versions - Multiple config directories +- Debugger must work ## Usage @@ -21,3 +22,14 @@ Used to rebuild the ad-nix system. ### `ads` Used to enter the development shell. Be careful, as this will create a `.devenv` directory and venv wherever it's entered. + +### venv + +Activated with `.devenv/state/venv/bin/activate`. Used in VSCode for type hints, running, and debugging + +### Jupyter + +- Install devenv kernel - might not be useful + - `python -m ipykernel install --user --name devenv --display-name "Python (devenv)"` +- Run jupyter notebook on the side with a `uv run jupyter notebook` command +- Use the link with the token to connect the jupyter notebook kernel to it