gravity-lang/docs/quickstart.md

Getting started

Install

To install Gravity, simply execute the commands given below. This should make two executables: gravity, the compiler itself and unittest, the test runner.

	git clone https://github.com/marcobambini/gravity.git
	cd gravity
	make

If you want to access the gravity compiler globally just add it to your PATH.
You can also use the Xcode project to create the gravity or unittest executables.

Configure your editor

Programming is way more enjoyable when you have the right tools. That's why we've equipped several code editors with Gravity support. Just click on your favourite editor and configure it accordingly:

• Visual Studio Code
• Atom
• vim
• BBEdit

Command line

To view all possible flags you can run the command below:

	./gravity --help

To compile a gravity file to a exec.json executable:

	./gravity -c myfile.gravity -o exec.json

To execute a precompiled json executable file:

	./gravity -x exec.json

To directly execute a gravity file (without first serializing it to json):

	./gravity myfile.gravity

Unit Tests

You can run unit tests by providing a path to a folder containing all test files:

	./gravity -t path_to_test_folder

This should produce output like:

<img src="assets/images/unittest.png" width="666px" height="466px">

Hello World

A simple Hello World code in Gravity looks like:

	func main() {
		System.print("Hello World!")
	}