Skip to content

Commit 14a361b

Browse files
authored
Merge pull request #2 from mcbarton/Update-readme
Update README.md to only talk about xeus-cpp kernel
2 parents b6911ad + af4e4dd commit 14a361b

File tree

1 file changed

+3
-77
lines changed

1 file changed

+3
-77
lines changed

README.md

Lines changed: 3 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,5 @@
1-
# Xeus-Lite demo
1+
# Xeus-cpp-wasm demo
22

3-
[![lite-badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://jupyterlite.github.io/xeus-lite-demo/notebooks/?path=demo.ipynb)
3+
This repo demostrates the capabilities of the latest release version of the xeus-cpp JupyterLite kernel
44

5-
This GitHub template allows you to create deployments of JupyterLite with a custom set of conda packages.
6-
7-
## 💡 How to make your own deployment
8-
9-
Creating a new deployment can be done in three easy steps:
10-
11-
**Step 1: Apply the GitHub template**
12-
13-
1. Click the **"Use this template"** button in the upper right corner of the GitHub repository.
14-
2. Choose a name for your project and select the GitHub organization where you want to create it.
15-
3. Then hit **"Create repository from template"** to finalize the setup.
16-
17-
**Step 2: Enable building the GitHub pages from GitHub actions.**
18-
19-
1. Once your repository is created, enable GitHub Pages by configuring GitHub Actions. This will build and deploy your site automatically.
20-
2. Your deployment will be accessible at the following URL: https://{USERNAME}.github.io/{DEMO_REPO_NAME}.
21-
22-
**Step 3: Customize your conda environment**
23-
24-
1. Update your ``environment.yml`` file to include the required packages.
25-
2. This ensures that your environment has all the necessary dependencies.
26-
27-
## 🎬 Visual Guide
28-
29-
For a step-by-step visual guide, check out the screencast below:
30-
31-
![Deploy your own](deploy.gif)
32-
33-
## 📦 How to install kernels and packages
34-
35-
You can install specific kernels and extra packages by adding them to the ``environment.yml`` file.
36-
37-
See https://jupyterlite-xeus.readthedocs.io/en/latest/environment.html for more documentation.
38-
39-
### Example 1: JupyterLite with NumPy and Matplotlib
40-
41-
To create a JupyterLite deployment with NumPy and Matplotlib pre-installed, edit the ``environment.yml`` file as follows:
42-
43-
```yml
44-
name: xeus-kernel
45-
channels:
46-
- https://repo.prefix.dev/emscripten-forge-dev
47-
- https://repo.prefix.dev/conda-forge
48-
dependencies:
49-
- xeus-python
50-
- numpy
51-
- matplotlib
52-
```
53-
54-
### Example 2: JupyterLite with R and coursekata
55-
56-
To use the R kernel and the coursekata package, edit the environment.yml file as follows:
57-
58-
```yml
59-
name: xeus-kernel
60-
channels:
61-
- https://repo.prefix.dev/emscripten-forge-dev
62-
- https://repo.prefix.dev/conda-forge
63-
dependencies:
64-
- xeus-r
65-
- r-coursekata
66-
```
67-
68-
### Example 3: JupyterLite with C++
69-
70-
To use the C++ kernel, edit the environment.yml file as follows:
71-
72-
```yml
73-
name: xeus-kernel
74-
channels:
75-
- https://repo.prefix.dev/emscripten-forge-dev
76-
- https://repo.prefix.dev/conda-forge
77-
dependencies:
78-
- xeus-cpp
79-
```
5+
[![lite-badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://compiler-research.org/xeus-cpp-wasm/lab/index.html)

0 commit comments

Comments
 (0)