readme

Author: PhilippPelz

README.md

@@ -1,52 +1,4 @@
-# marimo WebAssembly + GitHub Pages Template
+# marimo WebAssembly apps and notebooks
 
-This template repository demonstrates how to export [marimo](https://marimo.io) notebooks to WebAssembly and deploy them to GitHub Pages.
+marimo apps of the ECLIPSE group
 
-## 📚 Included Examples
-
-- `apps/charts.py`: Interactive data visualization with Altair
-- `notebooks/fibonacci.py`: Interactive Fibonacci sequence calculator
-- `notebooks/penguins.py`: Interactive data analysis with Polars and marimo
-
-## 🚀 Usage
-
-1. Fork this repository
-2. Add your marimo files to the `notebooks/` or `apps/` directory
-   1. `notebooks/` notebooks are exported with `--mode edit`
-   2. `apps/` notebooks are exported with `--mode run`
-3. Push to main branch
-4. Go to repository **Settings > Pages** and change the "Source" dropdown to "GitHub Actions"
-5. GitHub Actions will automatically build and deploy to Pages
-
-## Including data or assets
-
-To include data or assets in your notebooks, add them to the `public/` directory.
-
-For example, the `apps/charts.py` notebook loads an image asset from the `public/` directory.
-
-```markdown
-<img src="public/logo.png" width="200" />
-```
-
-And the `notebooks/penguins.py` notebook loads a CSV dataset from the `public/` directory.
-
-```python
-import polars as pl
-df = pl.read_csv(mo.notebook_location() / "public" / "penguins.csv")
-```
-
-## 🧪 Testing
-
-To test the export process, run `scripts/build.py` from the root directory.
-
-```bash
-python scripts/build.py
-```
-
-This will export all notebooks in a folder called `_site/` in the root directory. Then to serve the site, run:
-
-```bash
-python -m http.server -d _site
-```
-
-This will serve the site at `http://localhost:8000`.

README2.md

@@ -0,0 +1,52 @@
+# marimo WebAssembly + GitHub Pages Template
+
+This template repository demonstrates how to export [marimo](https://marimo.io) notebooks to WebAssembly and deploy them to GitHub Pages.
+
+## 📚 Included Examples
+
+- `apps/charts.py`: Interactive data visualization with Altair
+- `notebooks/fibonacci.py`: Interactive Fibonacci sequence calculator
+- `notebooks/penguins.py`: Interactive data analysis with Polars and marimo
+
+## 🚀 Usage
+
+1. Fork this repository
+2. Add your marimo files to the `notebooks/` or `apps/` directory
+   1. `notebooks/` notebooks are exported with `--mode edit`
+   2. `apps/` notebooks are exported with `--mode run`
+3. Push to main branch
+4. Go to repository **Settings > Pages** and change the "Source" dropdown to "GitHub Actions"
+5. GitHub Actions will automatically build and deploy to Pages
+
+## Including data or assets
+
+To include data or assets in your notebooks, add them to the `public/` directory.
+
+For example, the `apps/charts.py` notebook loads an image asset from the `public/` directory.
+
+```markdown
+<img src="public/logo.png" width="200" />
+```
+
+And the `notebooks/penguins.py` notebook loads a CSV dataset from the `public/` directory.
+
+```python
+import polars as pl
+df = pl.read_csv(mo.notebook_location() / "public" / "penguins.csv")
+```
+
+## 🧪 Testing
+
+To test the export process, run `scripts/build.py` from the root directory.
+
+```bash
+python scripts/build.py
+```
+
+This will export all notebooks in a folder called `_site/` in the root directory. Then to serve the site, run:
+
+```bash
+python -m http.server -d _site
+```
+
+This will serve the site at `http://localhost:8000`.