Skip to content

Commit ec98ec7

Browse files
committed
docs: Update README.md
Closes #8
1 parent 4fa05dd commit ec98ec7

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,8 @@ It's perfectly alright to display the full blown yaml file when reporting a bug,
3535

3636
![C1 view](./images/c1_view.drawio.svg)
3737

38-
# Call examples:
39-
### If a local copy of the repo is used:
40-
`python -m new_conda_env.cli -old_ver 3.10 -new_ver 3.9 -env_to_clone ds310 -new_env_name ds39`
41-
42-
### After installation of `new_conda_env` from conda-forge [TODO]:
38+
# Call example:
39+
### After installation of `new_conda_env` from conda-forge:
4340
`new-conda-env -old_ver 3.10 -new_ver 3.9 -env_to_clone ds310 -new_env_name ds39`
4441

4542
# User-supplied data:
@@ -51,14 +48,18 @@ It's perfectly alright to display the full blown yaml file when reporting a bug,
5148
6. `kernel (optional)`: Default & only kernel implemented: python
5249
7. `display_new_yml (optional, True)`: Whether to display the new yml file
5350
8. `log_level (optional, 'ERROR')`: for logging control
54-
51+
52+
### Note:
53+
`old_ver` and `new_ver` can be the same in case you want to obtain a 'lean' yaml file for
54+
for an existing environment with the same version.
55+
5556
# Output:
5657
The final file is named using this pattern: `f"lean_env{kernel[:2]}{new_ver}_from_{env_to_clone}.yml"` using the default naming for the new env, or: `f"lean_{new_env_name}_from_{env_to_clone}.yml"` using the user-provided name.
5758

5859
# Final file example:
5960
The following command `(base) >new-conda-env -old_ver 3.10 -new_ver 3.9 -env_to_clone ds310` will use
6061
an environment named "ds310" using python 3.10 to output a yaml file for a "lean" copy using python 3.9.
61-
The final file — on my system — is:
62+
The final file — on my Windows system — is:
6263
```
6364
name: envpy39
6465
channels:
@@ -112,7 +113,9 @@ prefix: C:\Users\<you>\miniconda3\envs\envpy39
112113
[ x ] cli: Create
113114
[ x ] Add check in argparse: kernel version needs a dot
114115
[ x ] Add tests
115-
[ ] Upload to conda-forge
116+
[ x ] Upload to conda-forge
117+
[ x ] Use pyproject.toml only
118+
[ ] FUTURE: Implement "incremental" env yaml creation -> new entry point
116119
[ ] Do same for julia, R kernels (if requested with enhancement issues)
117120

118121
---

0 commit comments

Comments
 (0)