Skip to content

Commit 3300e1b

Browse files
docs(readme): add tl;dr one-line test
Signed-off-by: Cameron Smith <cameron.ray.smith@gmail.com>
1 parent bc4cecb commit 3300e1b

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,39 @@ init github:sciexp/python-nix-template -o new-python-project
1717

1818
[^omnix]: If you have omnix installed you just need `om init ...` and not `nix run ... -- init`
1919

20+
tl;dr
21+
22+
<details><summary>one command to copy and paste</summary>
23+
24+
```sh
25+
rm -fr pnt-new && \
26+
nix --accept-flake-config run github:juspay/omnix -- init github:sciexp/python-nix-template/main -o pnt-new --non-interactive --params '{
27+
"package-name-kebab-case": "pnt-new",
28+
"package-name-snake-case": "pnt_new",
29+
"include-functional-package": false,
30+
"git-org": "pnt-new",
31+
"author": "PntNew",
32+
"author-email": "new@pnt.org",
33+
"include-vscode": true,
34+
"include-github-ci": true,
35+
"include-flake-template": false
36+
}' && \
37+
cd pnt-new && \
38+
git init && \
39+
git commit --allow-empty -m "initial commit (empty)" && \
40+
git add . && \
41+
nix run .#fix-template-names -- python-nix-template && \
42+
uv lock && \
43+
direnv allow
44+
```
45+
46+
</details>
47+
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`.
52+
2053
### Quick start
2154

2255
#### nix-managed environment

0 commit comments

Comments
 (0)