Skip to content

Commit a011b03

Browse files
Merge pull request #88 from pyscript/issue-87
Fix #87 - Added some detail about `.zip` and `.tar.gz` archives
2 parents 1eb82db + 141acc3 commit a011b03

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* [Terminology](#terminology) - what we mean by "_term_" in this document
88
* [Bootstrapping core](#bootstrapping-core) - how to enable Polyscript in your page
99
* [How Scripts Work](#how-scripts-work) - how `<script type="...">` works
10-
* [Extra config Features](#extra-config-features) - how to load *JS* modules on either main or workers
10+
* [Extra config Features](#extra-config-features) - how to load *JS* modules on either main or workers and how to untar or unzip archives into the Virtual File System
1111
* [The polyscript Module](#the-polyscript-module) - what is exported in *polyscript*
1212
* [How Events Work](#how-events-work) - how `<button py-click="...">` works
1313
* [XWorker](#xworker) - how `XWorker` class and its `xworker` reference work
@@ -347,6 +347,13 @@ fn()
347347
```
348348
349349
350+
### .tar.gz and .zip files
351+
352+
If the `[files]` entry in the *config* contains a `xxxxx.tar.gz` or `xxxxx.zip` **source**, and it's destination / target is a folder with a star, such as `/*` for root or `./dest/*` for local folders, both *Pyodide* and *MicroPython* runtimes will be able to extract that compressed archive automatically into the Virtual File System and at exactly that location.
353+
354+
This feature is hence available on *PyScript* too.
355+
356+
350357
351358
## The `polyscript` Module
352359

0 commit comments

Comments
 (0)