Skip to content

Commit

Permalink
Update README.md to reflect the current state of update.
Browse files Browse the repository at this point in the history
  • Loading branch information
haxpor committed Jan 27, 2017
1 parent 08102c5 commit 8d210e5
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,32 +33,42 @@ Be warned that you **should not** call `pod update` as newer version of pod fram
1. `git submodule update --init` to update git submodule
2. `pod install` to pull down dependencies into our project
3. `carthage update` to pull down dependencies into `Carthage/Checkouts` folder and build each one
4. Search for `io.wasin.potatso` for project-wide, and replace it with your own domain name. This is necessary as you need to create your own provisioning profile as it uses your domain name.
4. Open Xcode **workspace** project (`Potatso.xcworkspace`).
1. Click on Potatso project, then click on `General` tap.
2. Click on `Potatso` target at Targets section.
3. Change its `Bundle Identifier` to match with your desire domain name for example `com.yourdomain.potatso`.
4. For the following targets, you change `io.wasin.potatso` to match your domain name. This means if you see `io.wasin.potatso.tunnel`, you change it to `com.yourdomain.potatso.tunnel`.
* `PacketTunnel`
* `TodayWidget`
* `PotatsoLibrary`
* `PacketProcessor`
* `PotatsoModel`
* `PotatsoBase`
5. Follow the guide in *Set up Guide - Apple Developer Website* section.
6. Build and Run the project. Done.

## Set up Guide - Apple Developer Website

Note that it's better to not allow Xcode to automatically manage yoru provisioning profile for the application included Potatso (main app), PacketTunnel (extension), and TodayWidget (extension). Most of the time, such provisioning profile won't generate on developer page, or point to generic one which makes it not working!.
Note that it's better to not allow Xcode to automatically manage your provisioning profile for the application included Potatso (main app), PacketTunnel (extension), and TodayWidget (extension). Most of the time, such provisioning profile won't generate on developer page, or point to generic one which makes it not working!.

So follow the following steps

* Create 3 App IDs for `Potatso`, `PacketTunnel`, and `TodayWidget`. Make sure to name bundle id for each one matches the ones that use in code. In this case `io.wasin.potatso`, `io.wasin.potatso.tunnel`, and `io.wasin.potatso.todaywidget` respectively. Rename to be your domain name freely.
* Create 3 App IDs for `Potatso`, `PacketTunnel`, and `TodayWidget` on Apple Developer website. Make sure to name bundle id for each one matches bundle identifier you used when setting up with Xcode. In this case `io.wasin.potatso`, `io.wasin.potatso.tunnel`, and `io.wasin.potatso.todaywidget` respectively. Rename to be your domain name freely.
* **`Potatso`**
Enable `App Groups`, `Game Center`, `iCloud`, `In-App Purchase`, `Network Extensions`, and `Push Notifications`.
* **`PacketTunnel`**
Enable `App Groups`, `Game Center`, `In-App Purchase`, and `Network Extensions`.
* **`TodayWidget`**
Enable `App Groups`, `Game Center`, `In-App Purchase`, and `Network Extensions`.

* Create 3 corresponding provisioning profile for each created App ID.
* Create 3 corresponding provisioning profile for each created App ID on Apple Developer website.
* Now go back to Xcode
* Click on project -> click on General tap -> select `Potatso` target and uncheck "Automatically manage signing" -> select a proper provisioning profile in both "Signing (Debug)" and "Signing (Release)".
* Do the same for `PacketTunnel` and `TodayWidget` target.

## TODO
## Code Notices

There're a couple of issues that needed to look at, but at tested, it doens't effect the functionality of the app.
There're a couple of issues that needed to look at, but at tested, it doen **not** effect the functionality of the app.

* In file `Potatso/Core/API.swift`, it's the following code focusing on line with comment that I can't figure it out yet how to migrate it to Swift 3 code.

Expand Down

0 comments on commit 8d210e5

Please sign in to comment.