Browse Source

Updated getting started

Marco Bambini 8 years ago
parent
commit
e71595dbef
3 changed files with 28 additions and 2 deletions
  1. 8 1
      docs/contributing.html
  2. 20 1
      docs/getting-started.html
  3. BIN
      docs/images/unittest.png

+ 8 - 1
docs/contributing.html

@@ -78,7 +78,14 @@
          	<h1 class="section-header">Contributing</h1><hr>
          				
 			<p class="section-content">
-				Contributions to Gravity are welcomed and encouraged! </p>
+				If you find any grammatical issue, please report it using Github Issues. Or, if some sentence or paragraph is difficult to understand, feel free to make a pull request. This book is in active development and I'll regularly update and improve it. I am not a native English speaker so feel free to correct me if something is not properly written.<br><br>If you have any question related to the material or the development of the book, feel free to open a GitHub issue or to contact me.</p>
+				<h4 class="section-h4">About me</h4>
+				<p>I am Marco Bambini and you can reach me at:
+				<ul>
+					<li>Twitter: <a href="https://twitter.com/sqlabs">sqlabs</a></li>
+					<li>Email: <a href="mailto:[email protected]"><code>[email protected]</code></a></li>
+				</ul>
+			</p>
          	</div>
          	<!-- END CONTENT -->
          	

+ 20 - 1
docs/getting-started.html

@@ -78,7 +78,26 @@
          	<h1 class="section-header">Getting started</h1><hr>
          				
 			<p class="section-content">
-				TO DO</p>
+			<p>Command line:</p>
+			<pre><code>
+	https://github.com/marcobambini/gravity.git
+	cd gravity
+	make
+			</code></pre>
+			</p>
+			<p>You can also use the <strong>Xcode</strong> project to create the gravity or unittest executables.</p>
+			<p>Unitest usage:</p>
+			<pre><code>
+	./unittest path_to_test_folder
+			</code></pre>
+			<p>You should obtain an output like:
+			<img src="images/unittest.png" width="666px" height="466px">
+			</p>
+			
+			<p>Gravity usage:</p>
+			<pre><code>
+	./gravity --help
+			</code></pre>
          	</div>
          	<!-- END CONTENT -->
          	

BIN
docs/images/unittest.png