Skip to content

Commit c0fe8cc

Browse files
Updated README with setup instructions
1 parent a8d6e76 commit c0fe8cc

File tree

1 file changed

+62
-1
lines changed

1 file changed

+62
-1
lines changed

README.md

+62-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,63 @@
11
# RealDeal
2-
eMerge of America 2017 Hackathon iOS App utilizing ARKit, Vision, and VISA's VMORC
2+
eMerge of America 2017 Hackathon iOS App utilizing ARKit, Google Cloud Vision API, and VISA VMORC API
3+
4+
## Technology
5+
6+
* Swift 3.0 / 4.0
7+
* Xcode 9.0.0 Beta
8+
* iOS 11 Beta
9+
* ARKit
10+
* Google Cloud Vision API
11+
* VISA VMORC API
12+
13+
## Requirements
14+
15+
* Swift 3.0 / 4.0
16+
* Xcode 9.0.0 Beta
17+
* iPad Pro with at least an A9 processor
18+
* Cocoapods 1.2.1
19+
* Ruby 2.3.1
20+
21+
## Installation
22+
23+
### Ruby
24+
Before installing CocoaPods, you will need the correct version of Ruby. For installing and managing different versions of Ruby on your local machine, we recommend using [Ruby Version Manager (RVM)](https://rvm.io/). Begin with the following command:
25+
```
26+
$ gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
27+
```
28+
Then run the following command to install RVM:
29+
```
30+
$ \curl -sSL https://get.rvm.io | bash -s stable
31+
```
32+
If the previous step is successful, run the following command to install Ruby 2.3.1:
33+
```
34+
$ rvm install ruby-2.3.1
35+
```
36+
Now run the following command to check that the correct version is being used:
37+
```
38+
$ ruby -v
39+
```
40+
The version reported should look like this:
41+
```
42+
ruby 2.3.1p112 (2016-04-26 revision 54768) [x86_64-darwin15]
43+
```
44+
45+
### Cocoapods
46+
[CocoaPods](https://cocoapods.org/) is a dependency manager for Cocoa projects. You can install it with the following command:
47+
```
48+
$ gem install cocoapods
49+
```
50+
51+
### Setup
52+
After installing CocoaPods, use the following command to clone the repo:
53+
```
54+
$ git clone git@github.com:silverlogic/RealDeal.git
55+
```
56+
Then run the following command to install the dependencies used:
57+
```
58+
$ pod install
59+
```
60+
Then run the following command to open the project and start coding:
61+
```
62+
$ open RealDeal.xcworkspace
63+
```

0 commit comments

Comments
 (0)