Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.34 KB

install.md

File metadata and controls

40 lines (31 loc) · 1.34 KB

Installation Instructions

We explain how to install ESMeta with the necessary environment settings from scratch. Our framework is developed in Scala, which works on JDK 17+. So before installation, please install JDK 17+ and sbt, an interactive build tool for Scala.

Download ESMeta

$ git clone https://github.com/es-meta/esmeta.git

Environment Setting

Insert the following commands to ~/.bashrc (or ~/.zshrc):

# for ESMeta
export ESMETA_HOME="<path to ESMeta>"   # IMPORTANT!!!
export PATH="$ESMETA_HOME/bin:$PATH"    # for executables `esmeta` and etc.
source $ESMETA_HOME/.completion         # for auto-completion in shell

The <path to ESMeta> should be the absolute path of the ESMeta repository.

Installation of ESMeta using sbt

Please type the following command to 1) update the git submodules, 2) generate binary file bin/esmeta, and 3) apply the .completion for auto-completion.

$ cd esmeta && git submodule update --init && sbt assembly && source .completion

If you see the following message, ESMeta is successfully installed:

$ esmeta
# Welcome to ESMeta v0.6.4 - ECMAScript Specification Metalanguage.
# Please type `esmeta help` to see the help message.