Merge pull request #1 from aaronjsutton/develop

Develop

Author: Aaron Sutton

CONTRIBUTING.md

@@ -6,4 +6,12 @@ If you wish to fix a bug or add a feature to Deck, do so by:
 2. Forking the repository, and creating a new branch for your feature or fix. 
 3. Committing your changes and submit a PR against `develop`. 
 
-Thank you for helping to improve Deck. 
+## Documentation Generation
+
+When you submit a PR and it is merged, documentation is automatically generated and updated by CI.
+
+For development purposes, docs can be generated by running the `generate-docs` 
+script located in `/scripts`.
+You must have [Doxygen](https://www.stack.nl/~dimitri/doxygen) installed.
+
+Thank you for helping to improve Deck. 

README.md

@@ -3,6 +3,8 @@
 Deck is a library that models and manipulates a
 simulated deck of cards.  
 
+[![Build Status](https://travis-ci.com/aaronjsutton/deck.svg?branch=master)](https://travis-ci.com/aaronjsutton/deck)
+
 # Getting Started
 Read the [Quick Start Guide](https://github.com/aaronjsutton/deck/wiki/Deck-Quick-Start-Guide) to learn how to use Deck.
 

deck.xcodeproj/project.pbxproj

@@ -56,12 +56,11 @@
 /* Begin PBXFileReference section */
 		CC0E129320C77E95002A3839 /* example */ = {isa = PBXFileReference; explicitFileType = "compiled.mach-o.executable"; includeInIndex = 0; path = example; sourceTree = BUILT_PRODUCTS_DIR; };
 		CC0E129520C77E95002A3839 /* deal.c */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.c; path = deal.c; sourceTree = "<group>"; };
-		CC0FED3A20C721E6001108A4 /* test-wrapper.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "test-wrapper.h"; sourceTree = "<group>"; };
+		CC0FED3A20C721E6001108A4 /* test-bridge.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "test-bridge.h"; sourceTree = "<group>"; };
 		CC1775D720C6D5CD00A183A2 /* Doxyfile */ = {isa = PBXFileReference; lastKnownFileType = text; path = Doxyfile; sourceTree = "<group>"; };
 		CC1775D820C6D5CD00A183A2 /* Makefile */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.make; path = Makefile; sourceTree = "<group>"; };
 		CC1775D920C6D5CD00A183A2 /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
 		CC1775DD20C6D5CD00A183A2 /* deploy_rsa.enc */ = {isa = PBXFileReference; lastKnownFileType = text; path = deploy_rsa.enc; sourceTree = "<group>"; };
-		CC1775DF20C6D5CD00A183A2 /* upload_docs.rb */ = {isa = PBXFileReference; lastKnownFileType = text.script.ruby; path = upload_docs.rb; sourceTree = "<group>"; };
 		CC1775E020C6D5CD00A183A2 /* generate_docs.rb */ = {isa = PBXFileReference; lastKnownFileType = text.script.ruby; path = generate_docs.rb; sourceTree = "<group>"; };
 		CC1775E320C6D5CD00A183A2 /* deck.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = deck.h; sourceTree = "<group>"; };
 		CC1775E420C6D5CD00A183A2 /* Makefile */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.make; path = Makefile; sourceTree = "<group>"; };
@@ -122,7 +121,6 @@
 			isa = PBXGroup;
 			children = (
 				CC1775DB20C6D5CD00A183A2 /* deploy */,
-				CC1775DF20C6D5CD00A183A2 /* upload_docs.rb */,
 				CC1775E020C6D5CD00A183A2 /* generate_docs.rb */,
 			);
 			path = scripts;
@@ -153,7 +151,7 @@
 			children = (
 				CC1775ED20C6D5CD00A183A2 /* munit */,
 				CC1775FB20C6D5CD00A183A2 /* deck_tests.c */,
-				CC0FED3A20C721E6001108A4 /* test-wrapper.h */,
+				CC0FED3A20C721E6001108A4 /* test-bridge.h */,
 				CCEE8F1720C71D880097C60D /* deck_unit_tests.m */,
 				CC1775EC20C6D5CD00A183A2 /* Makefile */,
 				CCEE8F1920C71D880097C60D /* Info.plist */,
@@ -196,11 +194,11 @@
 				CC7152E920CA094D00D37C72 /* CONTRIBUTING.md */,
 				CC1775D920C6D5CD00A183A2 /* README.md */,
 				CC1775D720C6D5CD00A183A2 /* Doxyfile */,
+				CC1775D820C6D5CD00A183A2 /* Makefile */,
 				CCACB5DA20C743F5008AE676 /* assets.xcassets */,
 				CC1775DA20C6D5CD00A183A2 /* scripts */,
 				CC1775E120C6D5CD00A183A2 /* src */,
 				CC1775EA20C6D5CD00A183A2 /* test */,
-				CC1775D820C6D5CD00A183A2 /* Makefile */,
 				CC0E129420C77E95002A3839 /* example */,
 				CC17761320C6E69C00A183A2 /* Products */,
 				CCEE8F1D20C71D9F0097C60D /* Frameworks */,

example/deal.c

@@ -1,5 +1,5 @@
 //
-//  main.c
+//  deal.c
 //  example
 //
 //  Created by Aaron Sutton on 6/5/18.

test/deck_tests.c

@@ -1,7 +1,7 @@
 #include "munit/munit.h"
 #include "../src/deck.h"
 #include "../src/shuffle.h"
-#include "test-wrapper.h"
+#include "test-bridge.h"
 
 /****************************************/
 /*            Setup/Teardown            */

test/deck_unit_tests.m

@@ -1,12 +1,12 @@
-  //
-  //  deck_unit_tests.m
-  //  deck-unit-tests
-  //
-  //  Created by Aaron Sutton on 6/5/18.
-  //
+//
+//  deck_unit_tests.m
+//  deck-unit-tests
+//
+//  Created by Aaron Sutton on 6/5/18.
+//
 
 #import <XCTest/XCTest.h>
-#import "test-wrapper.h"
+#import "test-bridge.h"
 #import "munit/munit.h"
 #import "../src/deck.h"
 
@@ -17,7 +17,7 @@ @interface deck_unit_tests : XCTestCase
 @implementation deck_unit_tests
 
 /**
- µnit test wrapper.
+ µnit test wrapper for Xcode.
  */
 - (void)testDeck {
   int res = obcj_deck_tests();