Getting Started

Walkthrough of how to build Jingle from source

Getting Started

• Overview

• Cloning the repository

• Optional: Add Jingle to path

• Running Jingle

Overview

This guide will show you how to get Jingle up and running. It includes instructions for both Windows and Unix platforms.

Cloning the repository

You must first clone the repository off of GitHub with the following command:

$ git clone https://github.com/jingle-lang/jingle.git

This will clone the entire Jingle repository into the shell's current directory.

Optional: Add Jingle to path

You can add Jingle to your path so you can access it at any time by simply typing jingle into your command line. There is a script in source/tooling that automatically sets your path on Windows and Unix platforms. But you can easily do it manually, without the script.

Running Jingle

You can simply run Jingle by executing the Python file jingle.py in the source directory. Without any arguments it will simply show the help page. View the next page to see the CLI commands.