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…

27.7K ·GitHub
Emscripten
Что это такое?Emscripten — это компилятор с открытым исходным кодом, который превращает код на C и C++ в WebAssembly, используя LLVM и Binaryen. Благодаря ему проекты, написанные для нативных платформ, могут работать в вебе, в Node.js и в других средах с поддержкой wasm.
Это инструмент, который я устанавливаю на свой компьютер, или какой-то онлайн-сервис?Это локальный набор инструментов для компиляции: после установки вы собираете проекты из командной строки командой emcc — точно так же, как пользовались бы gcc или clang. Никакого hosted-сервиса здесь нет.
Можно ли использовать это в коммерческих проектах?Да. Проект распространяется по двойной лицензии — MIT и University of Illinois/NCSA Open Source License. Обе разрешающие, и с практической точки зрения разницы между ними почти нет — можно просто считать это MIT, которая допускает и коммерческое, и некоммерческое использование.
Что такое emrun?Это вспомогательный инструмент, который раздаёт сгенерированную HTML-страницу (например, hello.html), чтобы вы могли открыть и протестировать скомпилированное приложение локально; впрочем, подойдёт любой веб-сервер на ваш выбор.
Насколько зрелый этот проект?Очень: он на GitHub с 2011 года, у него около 27 700 звёзд, и с его помощью были портированы известные нативные приложения, такие как игровой движок Unity и Google Earth.
What are similar projects?scriptc, CalcKernel, cppinsights, compiler, wasmer, assemblyscript, carbon-lang, WasmEdge
Which topics is it in?emscripten, clang, llvm, toolchain, opengl, webassembly, compiler, wasm, c, cpp, c++, hacktoberfest
Creator
emscripten-core
Size
267.5 MB
Stars
27.7K
Updated
CommitOct 20Release6.0.13Oct 19
Age
15y
Commits · 90 Days