Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
manzt committed Oct 28, 2024
1 parent 00b105a commit 153e1a4
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,20 @@ Alternatively, create and manage your own virtual environment:
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
jupyter lab example.ipynb
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
The widget front-end code bundles it's JavaScript dependencies. After setting up Python,
make sure to install these dependencies locally:
\`\`\`sh
npm install
\`\`\`
While developing, you can run the following in a separate terminal to automatically
rebuild JavaScript as you make changes:
\`\`\`sh
npm run dev
\`\`\`
Expand Down Expand Up @@ -253,13 +260,20 @@ Alternatively, create and manage your own virtual environment:
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
jupyter lab example.ipynb
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
The widget front-end code bundles it's JavaScript dependencies. After setting up Python,
make sure to install these dependencies locally:
\`\`\`sh
npm install
\`\`\`
While developing, you can run the following in a separate terminal to automatically
rebuild JavaScript as you make changes:
\`\`\`sh
npm run dev
\`\`\`
Expand Down Expand Up @@ -507,13 +521,20 @@ Alternatively, create and manage your own virtual environment:
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
jupyter lab example.ipynb
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
The widget front-end code bundles it's JavaScript dependencies. After setting up Python,
make sure to install these dependencies locally:
\`\`\`sh
npm install
\`\`\`
While developing, you can run the following in a separate terminal to automatically
rebuild JavaScript as you make changes:
\`\`\`sh
npm run dev
\`\`\`
Expand Down Expand Up @@ -725,7 +746,7 @@ Alternatively, create and manage your own virtual environment:
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
jupyter lab example.ipynb
\`\`\`
Open \`example.ipynb\` in JupyterLab, VS Code, or your favorite editor
Expand Down Expand Up @@ -939,13 +960,20 @@ Alternatively, create and manage your own virtual environment:
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
jupyter lab example.ipynb
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
The widget front-end code bundles it's JavaScript dependencies. After setting up Python,
make sure to install these dependencies locally:
\`\`\`sh
npm install
\`\`\`
While developing, you can run the following in a separate terminal to automatically
rebuild JavaScript as you make changes:
\`\`\`sh
npm run dev
\`\`\`
Expand Down Expand Up @@ -1196,13 +1224,20 @@ Alternatively, create and manage your own virtual environment:
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
jupyter lab example.ipynb
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
The widget front-end code bundles it's JavaScript dependencies. After setting up Python,
make sure to install these dependencies locally:
\`\`\`sh
npm install
\`\`\`
While developing, you can run the following in a separate terminal to automatically
rebuild JavaScript as you make changes:
\`\`\`sh
npm run dev
\`\`\`
Expand Down Expand Up @@ -1419,13 +1454,20 @@ Alternatively, create and manage your own virtual environment:
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
jupyter lab example.ipynb
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
The widget front-end code bundles it's JavaScript dependencies. After setting up Python,
make sure to install these dependencies locally:
\`\`\`sh
npm install
\`\`\`
While developing, you can run the following in a separate terminal to automatically
rebuild JavaScript as you make changes:
\`\`\`sh
npm run dev
\`\`\`
Expand Down Expand Up @@ -1674,13 +1716,20 @@ Alternatively, create and manage your own virtual environment:
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
jupyter lab example.ipynb
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
The widget front-end code bundles it's JavaScript dependencies. After setting up Python,
make sure to install these dependencies locally:
\`\`\`sh
npm install
\`\`\`
While developing, you can run the following in a separate terminal to automatically
rebuild JavaScript as you make changes:
\`\`\`sh
npm run dev
\`\`\`
Expand Down Expand Up @@ -1894,7 +1943,7 @@ Alternatively, create and manage your own virtual environment:
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
jupyter lab example.ipynb
\`\`\`
Open \`example.ipynb\` in JupyterLab, VS Code, or your favorite editor
Expand Down Expand Up @@ -2108,13 +2157,20 @@ Alternatively, create and manage your own virtual environment:
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
jupyter lab example.ipynb
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
The widget front-end code bundles it's JavaScript dependencies. After setting up Python,
make sure to install these dependencies locally:
\`\`\`sh
npm install
\`\`\`
While developing, you can run the following in a separate terminal to automatically
rebuild JavaScript as you make changes:
\`\`\`sh
npm run dev
\`\`\`
Expand Down
11 changes: 9 additions & 2 deletions packages/create-anywidget/create.js
Original file line number Diff line number Diff line change
Expand Up @@ -185,17 +185,24 @@ Alternatively, create and manage your own virtual environment:
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
jupyter lab example.ipynb
\`\`\`
`;

if (type === "bundled") {
body = body.concat(`\
You then need to install the JavaScript dependencies and run the development server.
The widget front-end code bundles it's JavaScript dependencies. After setting up Python,
make sure to install these dependencies locally:
\`\`\`sh
npm install
\`\`\`
While developing, you can run the following in a separate terminal to automatically
rebuild JavaScript as you make changes:
\`\`\`sh
npm run dev
\`\`\`
Expand Down

0 comments on commit 153e1a4

Please sign in to comment.