Update README.md

README.md

@@ -3,6 +3,24 @@ foldlings
 
 Crafting a 3D paper pop-up can be a lot of fun for the whole family, but designing the cuts and folds is often a trial and error process.  Inspired by paper art in the Rauner collection at Dartmouth and our own difficulty in constructing popups, we created an iOS application that makes the process easy and fun (Heimann).   Foldlings is a tool that assists in the exploratory process of creating a pop-up by allowing a user to simply draw lines and be guided in creating a well-defined pop-ups.  Sketches start with a blank drawing with a single driving fold. From this base, users touch screen to define a popup using our four tools: erase, fold, cut, and tab.  Cut and fold define new edges of planes.  During simulation, we detect fold orientation, so the user does not have to specify fold direction.  Our system also detects holes (enclosed paths) within planes.  The tab tool generates a plane that make the current design a valid 90-degree popup.
 
+running foldlings
+========
+1) run pod install
+2) open the foldlings.xcworkspace
+3) create a file called APIKeysAndOtherSecrets.swift, with API keys from Flurry and Amazon.  These features can also be disabled if logging is not desired
+
+Example file:
+     //  APIKeysAndOtherSecrets.swift
+     //  foldlings
+
+     import Foundation
+
+     let KEY_FLURRY = "REPLACE_WITH_API_KEY"
+     let COGNITO_IDENTITY_POOL = "REPLACE_WITH_IDENTITY_POOL"
+     let S3_BUCKET_NAME = "foldlings"
+     let APP_STORE_ID = "123456"
+
+
 key methods and classes
 =========