Skip to content

Commit abf3165

Browse files
authored
feat: update usage instructions
1 parent c8b3f53 commit abf3165

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,18 @@ To use this repository, follow the steps below:
1818

1919
1. Create new repository by clicking the Use this template button above.
2020
2. Open your duplicated repository in VSCode using the command ">Dev Containers: Clone Repositories in Named Container Volume". You can name your container for easy referencing.
21+
22+
## mise and py-init
23+
24+
This devcontainer uses "mise" (a small environment/tool manager) and a convenience shell helper named `py-init` to quickly create a mise-managed Python environment and a project virtualenv.
25+
26+
Quick usage
27+
- Open a new shell and cd into your project directory.
28+
- Run:
29+
- py-init 3.11
30+
- or any supported version (e.g. py-init 3.10, py-init 3.13)
31+
32+
What py-init does
33+
- Creates/updates a local mise.toml in the current directory.
34+
- Uses mise to select the requested Python version.
35+
- Configures the local virtualenv path to .venv and enables automatic creation.

0 commit comments

Comments
 (0)