c
/
gravity-lang
mirror of https://github.com/marcobambini/gravity.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
							<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Gravity: Getting started</title>
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/5.0.0/normalize.min.css" />
    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
    <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,800">
    <link rel="stylesheet" href="scripts/highlight/styles/github-gist.css">
    <link rel="stylesheet" href="stylesheets/styles.css">
  </head>
  <body>

	<!-- BEGIN NAVIGATION BAR -->
	<nav class="navbar navbar-default navbar-fixed-top">
		<div class="container">
		<div class="navbar-header">
			<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
				<span class="sr-only">Toggle navigation</span>
				<span class="icon-bar"></span>
				<span class="icon-bar"></span>
				<span class="icon-bar"></span>
			</button>
			<a class="navbar-brand" href="http://gravity-lang.org"><img src="images/logo.png" width="32px" height="36px"></a>
		</div>
		<div id="navbar" class="navbar-collapse collapse">
			<ul class="nav navbar-nav navbar-right">
				<li class="active"><a href="index.html">Gravity</a></li>
				<li><a href="internals/index.html">Internals</a></li>
				<li><a href="https://github.com/marcobambini/gravity">GitHub</a></li>
			</ul>
		</div><!--/.nav-collapse -->
	</div>
	</nav>
	<!-- END NAVIGATION BAR -->

	<div class="container body-container">
		<div class="main-content">
			<div class="row">

       		<!-- BEGIN SIDEBAR -->
       		<div class="col-sm-3 border-right section-left">
				<div saveheight="1" class="sidebar-nav">
				<h4>INTRODUCTION</h4>
				<ul>
					<li><a href="index.html"><span>Introduction</span></a></li>
					<li><a href="getting-started.html" class="active"><span>Getting Started</span></a></li>
				</ul>
				<h4>LANGUAGE GUIDE</h4>
				<ul>
					<li><a href="syntax.html"><span>Syntax</span></a></li>
					<li><a href="operators.html"><span>Operators</span></a></li>
					<li><a href="types.html"><span>Types</span></a></li>
					<li><a href="lists.html"><span>Lists</span></a></li>
					<li><a href="maps.html"><span>Maps</span></a></li>
					<li><a href="enum.html"><span>Enum</span></a></li>
					<li><a href="functions.html"><span>Functions</span></a></li>
					<li><a href="closures.html"><span>Closures</span></a></li>
					<li><a href="classes.html"><span>Classes</span></a></li>
					<li><a href="control-flow.html"><span>Control Flow</span></a></li>
					<li><a href="loops.html"><span>Loops</span></a></li>
					<li><a href="fibers.html"><span>Fibers</span></a></li>
				</ul>
				<h4>ADVANCED</h4>
				<ul>
					<li><a href="api.html"><span>Embedding API</span></a></li>
					<li><a href="system.html"><span>System class</span></a></li>
					<li><a href="math.html"><span>Math class</span></a></li>
					<li><a href="unit-test.html"><span>Unit test</span></a></li>
					<li><a href="contributing.html"><span>Contributing</span></a></li>
				</ul>
				</div>
			</div>
			<!-- END SIDEBAR -->

			<!-- BEGIN CONTENT -->
       		<div class="col-sm-9 border-left section-right">
         	<h1 class="section-header">Getting started</h1><hr>

			 <!-- Installation -->
			 <h4 class="section-h4">Install</h4>

			<p class="section-content">
			To install Gravity, simply execute the commands given below. It should make two executables: the compiler itself
			and test runner.
			<pre><code>
	git clone https://github.com/marcobambini/gravity.git
	cd gravity
	make
			</code></pre>
			</p>

			<blockquote>
				<p>If you want to access the gravity compiler globally just add it to your <b>PATH</b>!</p>
			</blockquote>

			<blockquote>
				<p>You can also use the <strong>Xcode</strong> project to create the gravity or unittest executables.</p>
			</blockquote>

			<!-- Editor -->
			<h4 class="section-h4">Configure your editor</h4>
			<p>
				Programming is way more enjoyable when you have the right tools! That's why we
                equipped several code editors with Gravity support!
				Just click on your favourite editor and configure it accordingly:
				<ul>
					<li><a href="https://github.com/Dohxis/vscode-gravity">Visual Studio Code</a></li>
					<li><a href="https://github.com/Tribex/atom-language-gravity">Atom</a></li>
					<li><a href="https://github.com/hallzy/gravity.vim">vim</a></li>
					<li><a href="https://github.com/marcobambini/bbedit-gravity">BBEdit/TextWrangler</a></li>
				</ul>
			</p>

			<!-- Command line -->
			<h4 class="section-h4">Command line</h4>
			<p>To view all possible flags you can run the command below:</p>
			<pre><code>
	./gravity --help
			</code></pre>

			<p>To compile a gravity file to a exec.json executable:</p>
			<pre><code>
	./gravity -c myfile.gravity -o exec.json
			</code></pre>

			<p>To execute a precompiled json executable file:</p>
			<pre><code>
	./gravity -x exec.json
			</code></pre>

			<p>To directly execute a gravity file (without first serializing it to json):</p>
			<pre><code>
	./gravity myfile.gravity
			</code></pre>

			<!-- Command line -->
			<h4 class="section-h4">Unit Tests</h4>
			<p>You can run unit tests by providing a path to a folder containing all tests:</p>
			<pre><code class="swift">
	./unittest path_to_test_folder
			</code></pre>
			<p>You should obtain an output like:
			<img src="images/unittest.png" width="666px" height="466px">
			</p>
			
			<h4 class="section-h4">Hello World</h4>
			<p>A simple <strong>Hello World</strong> code in Gravity looks like</p>
			<pre><code>
			    func main() {
			        System.print("Hello World!")
			    }
			</code></pre>

         	</div>
         	<!-- END CONTENT -->

       	</div> <!-- /row -->
       </div> <!-- /main-content -->
     </div> <!-- /container -->

	<!-- BEGIN FOOTER -->
	<footer class="navbar-fixed-bottom">
		<div class="container footer">
			<p>
			</p>
		</div>
	</footer>
    <!-- END FOOTER -->

	<!-- Bootstrap JS -->
	<script src="https://code.jquery.com/jquery-1.12.4.min.js"></script>
	<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>

	<!-- Highlights JS -->
    <script src="scripts/highlight/highlight.min.js"></script>
    <script>hljs.initHighlightingOnLoad();</script>

	</body>
</html>