Skip to content

Commit aa60b88

Browse files
committed
Add instructions for dev env + include yarn in them.
1 parent 1952d48 commit aa60b88

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,14 @@ After this, you will have a directory containing files used for creating a
3939
custom Jupyter widget. To check that eveything is set up as it should be,
4040
you should run the tests:
4141

42+
Create a dev environment:
43+
```bash
44+
conda create -n {{ cookiecutter.python_package_name }}-dev -c conda-forge nodejs yarn python jupyterlab
45+
conda activate {{ cookiecutter.python_package_name }}-dev
46+
```
47+
48+
Install the python. This will also build the TS package.
49+
4250
```bash
4351
# First install the python package. This will also build the JS packages.
4452
pip install -e ".[test, examples]"

{{cookiecutter.github_project_name}}/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,14 @@ jupyter nbextension enable --py [--sys-prefix|--user|--system] {{ cookiecutter.p
2323

2424
## Development Installation
2525

26+
Create a dev environment:
27+
```bash
28+
conda create -n {{ cookiecutter.python_package_name }}-dev -c conda-forge nodejs yarn python jupyterlab
29+
conda activate {{ cookiecutter.python_package_name }}-dev
30+
```
2631

32+
Install the python. This will also build the TS package.
2733
```bash
28-
# First install the python package. This will also build the JS packages.
2934
pip install -e ".[test, examples]"
3035
```
3136

0 commit comments

Comments
 (0)