emscripten README

The project's README from github.com/emscripten-core/emscripten. As one markdown file: README.md.

emscripten logo

Main project page: https://emscripten.org

GitHub CI status: CircleCI

Chromium builder status: emscripten-releases

Overview

Emscripten compiles C and C++ to WebAssembly using LLVM and Binaryen. Emscripten output can run on the Web, in Node.js, and in wasm runtimes.

Emscripten provides Web support for popular portable APIs such as OpenGL and SDL2, allowing complex graphical native applications to be ported, such as the Unity game engine and Google Earth. It can probably port your codebase, too!

While Emscripten mostly focuses on compiling C and C++ using Clang, it can be integrated with other LLVM-using compilers (for example, Rust has Emscripten integration, with the wasm32-unknown-emscripten target).

Getting Started

For detailed instructions and tutorials, visit the Emscripten Website.

Installation

There are two primary ways to install Emscripten:

  1. Using the Emscripten SDK (emsdk) (Recommended) The easiest way to get started is by using the Emscripten SDK. Follow the instructions on the downloads page to install it.

  2. From a Git Checkout (Manual Installation) If you have cloned the repository from Git, you can install the dependencies manually and then run the bootstrap script:

    ./bootstrap.py
    

    For more details, see the developer guide.

Using the compiler

Run emcc like you would gcc or clang:

$ emcc hello.c -o hello.js
$ node hello.js
Hello, world!

Emscripten will compile your code into a WebAssembly module along with a JavaScript file that can load and run it. You can then run the resulting JavaScript in your browser or under Node.js (or Deno or Bun).

Emscripten can also generate a sample HTML page that then loads the JavaScript:

$ emcc hello.c -o hello.html

You can then serve the generated hello.html using the emrun tool, or a web server of your choosing.

Contributing

For information on how to contribute to the project, see CONTRIBUTING.md and the Contributing section on the website.

License

Emscripten is available under 2 licenses, the MIT license and the University of Illinois/NCSA Open Source License.

Both are permissive open source licenses, with little if any practical difference between them.

The reason for offering both is that (1) the MIT license is well-known and suitable for a compiler toolchain, while (2) LLVM's original license, the University of Illinois/NCSA Open Source License, was also offered to allow Emscripten's code to be integrated upstream into LLVM. The second reason became less important after Emscripten switched to the LLVM wasm backend, at which point there isn't any code we expect to move back and forth between the projects; also, LLVM relicensed to Apache 2.0 + exceptions meanwhile. In practice you can just consider Emscripten as MIT licensed (which allows you to do pretty much anything you want with a compiler, including commercial and non-commercial use).

See LICENSE for the full content of the licenses.

emscripten (emscripten-core/emscripten)

Searching Database…

这是什么?Emscripten 是一个开源编译器,它借助 LLVM 和 Binaryen 把 C 和 C++ 代码编译成 WebAssembly,让原生代码库可以在网页上、Node.js 以及其他 wasm 运行环境中运行。
它是装在我电脑上的工具,还是某种在线服务?它是一套本地编译工具链:安装后,你在命令行里用 emcc 进行编译,用法和你平时用 gcc 或 clang 一模一样。它完全不是托管服务。
我可以在商业项目里使用它吗?可以。它同时采用 MIT 和伊利诺伊大学厄巴纳-香槟分校/NCSA 开源许可证双重授权,两者都很宽松,实际差别很小——实践中直接把它当成 MIT 就行,无论商业还是非商业用途都允许。
emrun 是什么?它是一个配套工具,用来把生成的 HTML 页面(比如 hello.html)跑在本地服务器上,方便你打开并测试编译好的应用;用你自己选的任意网页服务器也完全可行。
这个项目成熟吗?非常成熟:它从 2011 年起就在 GitHub 上了,目前有大约 27,700 个 star,Unity 游戏引擎和 Google Earth 这类知名原生应用都曾借助它完成移植。
Size
267.5 MB
Stars
27.7K
Age
15y
Commits · 90 Days