README.md 2.33 KB
Newer Older
Patrick Murray's avatar
Patrick Murray committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37


What's Open for iOS
===

Simple iOS app to ingest the What's Open API, cache its contents in a local datastore and display it in a user friendly way. Plans to take advantage of iPhone specific technologies not available to the web. 



**THIS PROJECT IS BRAND NEW. PLEASE STANBY WHILE IT IS SET UP**




On Contributing
---

WhatsOpeniOS welcomes all the help it can get. Even if you don't feel like you can be helpful the more technical aspects, we definitely need designers, technical writers, and testers. 

There are many things that can be done with this project (see the "To Do" section), but sometimes it's the small things that count, so don't be afraid of contributing just a small spelling mistake.

If you need help at all please contact and SRCT member. We want people to contribute, so if you are struggling, or just want to learn we are more than willing to help.

The project lead for this project is **Pat Murray**. *pmurray8@gmu.edu*

Please visit the [SRCT Wiki](http://wiki.srct.gmu.edu/) for more information on this and other SRCT projects, along with other helpful links and tutorials.


Setup
---
To get started, you'll need the following installed:
* [Git](http://git-scm.com/book/en/Getting-Started-Installing-Git)

* The latest **public** build of [Xcode](https://developer.apple.com/xcode/) (and a compatible Mac). *Currently Xcode 8*

* The latest **public** release of Swift. *Currently Swift 3.0* (bundled with Xcode)

Patrick Murray's avatar
Patrick Murray committed
38
* This project also contains many dependancies. Due to the shifting nature of dependency management in Cocoa development, this project will (for the foreseeable future) use Git-submodules. I've never personally used these in a shipping application, so theres no better time to start! 
Patrick Murray's avatar
Patrick Murray committed
39

Patrick Murray's avatar
Patrick Murray committed
40
* Other language or framework-specific items  
Patrick Murray's avatar
Patrick Murray committed
41
  Open a terminal window and type in the following commands. (If you're on Windows, use [Cygwin](http://www.cygwin.com/). This will create a local, workable copy of the project.
Patrick Murray's avatar
Patrick Murray committed
42
43
  ``bash``  
  ``git clone git@git.gmu.edu:pmurray8/WhatsOpeniOS.git``  
Patrick Murray's avatar
Patrick Murray committed
44
45
46
47
48
49
50

  To-do
---
Note-- this should also be on the wiki
About GMU SRCT
---
**S**tudent - **R**un **C**omputing and **T**echnology (*SRCT*, pronounced "circuit") is a student organization at George Mason University which enhances student computing at Mason. SRCT establishes and maintains systems which provide specific services for Mason's community.