README.md

   1 # Node.js on Escargot
   2
   3 Node.js on Escargot is a memory efficient node.js implementation,
   4 which runs on top of [Escargot](https://github.com/Samsung/escargot),
   5 a memory optimized JavaScript Engine developed by Samsung Research,
   6 instead of the default V8 JS engine.
   7
   8 ## Supported Platforms
   9 * Ubuntu 18.04, 16.04
  10 * Tizen 4.0 and above
  11
  12 ## Checkout code
  13 ```
  14 git clone git@github.sec.samsung.net:lws/node-escargot.git
  15 git submodule update --init --recursive
  16 ```
  17
  18 ## How to Compile: Ubuntu
  19 ### Install required packages
  20 ```
  21 sudo apt-get install -y build-essential cmake clang libicu-dev
  22 ```
  23
  24 ### Compile
  25 1. Generate build config files and build node.js
  26 ```
  27 ./lwnode/build.sh
  28 ./lwnode/build-cctest.sh
  29 ```
  30
  31 ### How to run
  32 ```
  33 ./node ./test/message/hello_world.js
  34 ```
  35
  36 ## How to Compile: Tizen
  37 ### Prerequisite
  38 Set up a gbs build environment on a Ubuntu machine.
  39
  40 ### Build with gbs command
  41 You can also build by using the gbs command without using the build util.
  42 When using the gbs command, you need to defien a profile.
  43 ```
  44 gbs -c ~/gbs.conf build -A arm7l --define 'build_profile tv'
  45 ```
  46 Build Options
  47 * --define 'build_profile `none|tv|kiosk|soundbar`': default is `none`
  48 * --define 'build_mode `release|debug`': default is `release`
  49
  50 ## Maintainers
  51 A list of maintainers can be found in [MAINTAINERS.md](MAINTAINERS.md).