getting-started.md

layout	title	permalink
page	Getting Started	/getting-started/

Quick Start

The easiest way to start playing with runtime.js is to clone Hello World repository and run it in QEMU. First, make sure you have Node.js and QEMU installed.

Install Node.js

Install Node.js if you don't have it already installed. https://nodejs.org/download/. npm package manager will also be installed.

Install QEMU

Install using Homebrew on OSX:

brew install qemu

Install on Ubuntu:

sudo apt-get install qemu

Install on Windows:

QEMU binaries http://qemu.weilnetz.de/

set PATH=%PATH%;C:\Program Files\qemu

See also:

http://wiki.qemu.org/Download
http://en.wikibooks.org/wiki/QEMU/Installing_QEMU

Install runtime.js command line tools

npm install runtime-cli -g

This adds global runtime command for easy access.

Hello World repository

Clone and install dependencies:

git clone https://github.com/runtimejs/helloworld.git
cd helloworld
npm install

Run:

npm start

Done, project should load and print "Hello World!".

New application

It's easy to create a new project and manage dependencies using npm package manager:

npm init
npm install runtimejs --save

index.js

console.log('It works!');

Run in QEMU:

runtime start

Next Steps

Check out GitHub repository. The project is in development and a lot of important features are missing. Contributions are welcome.