diff --git a/README.md b/README.md index 119e167..0e599b9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,26 @@ -Source code for the webvm.io webpage. +# WebVM -Please use github.com/webvm/issues to signal any bug. +This repository hosts the source code of the [https://webvm.io](https://webvm.io) live demo page. +WebVM is a server-less virtual Linux environment running fully client-side in HTML5/WebAssembly. In this demo, it runs an unmodified Debian distribution including many native development toolchains. + +WebVM is powered by the CheerpX virtualization engine, and enables safe, sandboxed client-side execution of x86 binaries on any browser. CheerpX includes an x86-to-WebAssembly JIT compiler, a virtual block-based file system, and a Linux syscall emulator. + +For more information: https://medium.com/leaningtech/webvm-client-side-x86-virtual-machines-in-the-browser-40a60170b361 + +# Bugs and Issues + +Please use [Issues](github.com/webvm/issues) to report any bug. + +## Browsers support + +|![](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png)
Chrome|![](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png)
Edge|![](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png)
Safari|![](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png)
Firefox| +|:---:|:---:|:---:|:---:| +|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:| + +WebVM and CheerpX are compatible with any browser, both on Desktop (Chrome/Chromium, Edge, Firefox, Safari), and Mobile (Chrome, Safari), provided support for [SAB](https://medium.com/r?url=https%3A%2F%2Fcaniuse.com%2F%3Fsearch%3DSharedArrayBuffer) is present, and the device has sufficient memory. + +# Other This project depends on xterm.js (https://xtermjs.org/) and on its add-on xterm-addon-fit @@ -18,3 +37,6 @@ cp ../build/node_modules/xterm-addon-fit/lib/xterm-addon-fit.js . cd .. rm -r build ``` + +# License +Copyright (c) Leaning Technologies Limited. All rights reserved.