Skip to content

Commit d510ce6

Browse files
docs(readme): note requirement to create git repo
Signed-off-by: Cameron Smith <cameron.ray.smith@gmail.com>
1 parent 170bb0d commit d510ce6

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ 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-
### Quick Start
20+
### Quick start
21+
22+
#### nix-managed environment
2123

2224
The template supports three types of development environments:
2325

@@ -33,7 +35,15 @@ make bootstrap
3335

3436
only the very first time you are setting up one of these templates. This will
3537
verify you have the [nix package manager](https://nix.dev) and
36-
[direnv](https://direnv.net/) installed. After this running
38+
[direnv](https://direnv.net/) installed. Registration of the repository contents requires
39+
creating a git repository, for example with
40+
41+
```sh
42+
git init && git commit --allow-empty -m "initial commit (empty)" && git add .
43+
```
44+
45+
but does not require committing.
46+
After this running
3747

3848
```sh
3949
direnv allow
@@ -45,6 +55,9 @@ provides an alternative to using [GNU Make](https://www.gnu.org/software/make/)
4555
as a task runner. See the [task runner](#task-runner) section for a listing of
4656
development commands.
4757

58+
You should now be able to run `pytest` or `just test` to confirm the package
59+
tests pass in the devshell environment.
60+
4861
#### python virtualenv
4962

5063
1. Create and sync virtual environment:

0 commit comments

Comments
 (0)