Skip to content

Commit a4d9e6c

Browse files
docs(readme): separate monorepo true/false one-line examples
Signed-off-by: Cameron Smith <cameron.ray.smith@gmail.com>
1 parent 7e21527 commit a4d9e6c

File tree

1 file changed

+41
-13
lines changed

1 file changed

+41
-13
lines changed

README.md

Lines changed: 41 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,36 +19,64 @@ init github:sciexp/python-nix-template -o new-python-project
1919

2020
tl;dr
2121

22-
<details><summary>one command to copy and paste</summary>
22+
<details><summary>instantiate a monorepo variant of the template</summary>
23+
24+
```sh
25+
nix --accept-flake-config run github:juspay/omnix -- init github:sciexp/python-nix-template -o pnt-mono --non-interactive --params '{
26+
"package-name-kebab-case": "pnt-mono",
27+
"package-name-snake-case": "pnt_mono",
28+
"monorepo-package": true,
29+
"git-org": "pnt-mono",
30+
"author": "Pnt Mono",
31+
"author-email": "mono@pnt.org",
32+
"vscode": true,
33+
"github-ci": true,
34+
"nix-template": false
35+
}' && \
36+
cd pnt-mono && \
37+
git init && \
38+
git commit --allow-empty -m "initial commit (empty)" && \
39+
git add . && \
40+
nix develop --accept-flake-config -c pytest
41+
```
42+
43+
</details>
44+
45+
You can run `direnv allow` to enter the shell environment that contains
46+
development dependencies or `nix develop --accept-flake-config` to enter (or add
47+
`-c command` to execute individual commands within) the development shell.
48+
49+
<details><summary>instantiate a single-package variant of the template</summary>
2350

2451
```sh
25-
rm -fr pnt-new && \
2652
nix --accept-flake-config run github:juspay/omnix -- init github:sciexp/python-nix-template/main -o pnt-new --non-interactive --params '{
2753
"package-name-kebab-case": "pnt-new",
2854
"package-name-snake-case": "pnt_new",
29-
"include-functional-package": false,
55+
"monorepo-package": false,
3056
"git-org": "pnt-new",
31-
"author": "PntNew",
57+
"author": "Pnt New",
3258
"author-email": "new@pnt.org",
33-
"include-vscode": true,
34-
"include-github-ci": true,
35-
"include-flake-template": false
59+
"vscode": true,
60+
"github-ci": true,
61+
"nix-template": false
3662
}' && \
3763
cd pnt-new && \
3864
git init && \
3965
git commit --allow-empty -m "initial commit (empty)" && \
4066
git add . && \
41-
nix run .#fix-template-names -- python-nix-template && \
4267
nix run nixpkgs#uv -- lock && \
43-
direnv allow
68+
nix develop --accept-flake-config -c pytest
4469
```
4570

4671
</details>
4772

48-
except you should update the git ref/rev from
49-
`github:sciexp/python-nix-template/main` to
50-
`github:sciexp/python-nix-template/3289dla` or
51-
`github:sciexp/python-nix-template/devbranch`.
73+
except you may want to update the git ref/rev of the template if you need to pin to a
74+
particular version:
75+
76+
- `github:sciexp/python-nix-template/main`
77+
- `github:sciexp/python-nix-template/v0.1.0`
78+
- `github:sciexp/python-nix-template/3289dla`
79+
- `github:sciexp/python-nix-template/devbranch`.
5280

5381
### Quick start
5482

0 commit comments

Comments
 (0)