asterius/docs/index.md

[![Docker Pulls](https://img.shields.io/docker/pulls/terrorjack/asterius.svg)](https://hub.docker.com/r/terrorjack/asterius)
[![CircleCI](https://circleci.com/gh/tweag/asterius/tree/master.svg?style=shield)](https://circleci.com/gh/tweag/asterius/tree/master)
[![Gitter](https://img.shields.io/gitter/room/tweag/asterius)](https://gitter.im/tweag/asterius)
[![Netlify Status](https://api.netlify.com/api/v1/badges/e7cfe6ef-b0e6-4a17-bd74-8bce6063f147/deploy-status)](https://asterius.netlify.com)

Asterius is a Haskell to WebAssembly compiler based on GHC. It compiles simple
Haskell source files or Cabal executable targets to WebAssembly+JavaScript code
which can be run in node.js or browsers. It features seamless JavaScript interop
(lightweight Async FFI with `Promise` support) and small output code (~600KB
`hello.wasm` for a [Hello
World](https://hackage.haskell.org/package/hello-1.0.0.2)). A lot of common
Haskell packages like `lens` are already supported. The project is actively
maintained by [Tweag I/O](https://tweag.io/).

# Contents

* [Overview](overview.md)
* [Building guide](building.md)
* [Cabal support](cabal.md)
* [Using ahc-dist/ahc-link](ahc-link.md)
* [JavaScript FFI](jsffi.md)
* [Template Haskell](th.md)
* [Invoking RTS API in JavaScript](rts-api.md)
* [IR types and transformation passes](ir.md)
* [The runtime debugging feature](debugging.md)
* [Project architecture](architecture.md)
* [Writing WebAssembly code in Haskell](wasm-in-hs.md)
* [WebAssembly as a Haskell compilation target](webassembly.md)
* [Using experimental WebAssembly features](wasm-experimental.md)
* [Hacking guide](hacking.md)
* [Reading list](readings.md)

# Sponsors

[<img src="https://www.tweag.io/img/tweag-med.png" height="65">](https://tweag.io)

Asterius is maintained by [Tweag I/O](https://tweag.io/).

Have questions? Need help? Tweet at [@tweagio](https://twitter.com/tweagio).