Skip to content

Commit e3a606c

Browse files
docs(readme): note requirements to setup monorepo package
Signed-off-by: Cameron Smith <cameron.ray.smith@gmail.com>
1 parent d510ce6 commit e3a606c

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ make bootstrap
3535

3636
only the very first time you are setting up one of these templates. This will
3737
verify you have the [nix package manager](https://nix.dev) and
38-
[direnv](https://direnv.net/) installed. Registration of the repository contents requires
39-
creating a git repository, for example with
38+
[direnv](https://direnv.net/) installed. Registration of the repository contents
39+
requires creating a git repository, for example with
4040

4141
```sh
4242
git init && git commit --allow-empty -m "initial commit (empty)" && git add .
@@ -58,6 +58,11 @@ development commands.
5858
You should now be able to run `pytest` or `just test` to confirm the package
5959
tests pass in the devshell environment.
6060

61+
If you choose to retain the monorepo leaf package in
62+
[packages/pnt-functional](./packages/pnt-functional) then you will need to run
63+
`just monorepo-patch uv-lock` to update the [pyproject.toml](./pyproject.toml)
64+
and [uv.lock](./uv.lock) to include it and its tests in the workspace.
65+
6166
#### python virtualenv
6267

6368
1. Create and sync virtual environment:

0 commit comments

Comments
 (0)