Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Update INSTALL.md for clarity #284

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 23 additions & 30 deletions docs/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,39 @@

Xcode 10.1 or above is required to run the app.

#### First Step
Run `./setup.sh` to download the required frameworks.
### Steps

#### Helpful Tools and Next Steps
1) Run `./setup.sh` to download the required frameworks.

2) Run `bundle install` to install dependencies located in the `Gemfile`.

3) Run `bundle exec pod install` to install dependencies located in the `Podfile`. This command guarantees that the version of CocoaPods specified in the `Gemfile.lock` is used to `pod install` the dependencies listed in the `Podfile.lock`.
zackshapiro marked this conversation as resolved.
Show resolved Hide resolved

---

### Helpful Tools

The following tools are used to simplify working on the app:

##### Bundler
#### Bundler

Bundler provides a consistent environment for Ruby projects by tracking and installing the exact gems and versions that are needed. In Zap iOS it is used to pin cocoapod and fastlane versions.

Install the dependencies located in the `Gemfile` by running:
If you would like to learn more take a look at https://www.mokacoding.com/blog/ruby-for-ios-developers-bundler/

```
bundle install
```
#### CocoaPods

If you would like to learn more take a look at https://www.mokacoding.com/blog/ruby-for-ios-developers-bundler/
For managing dependencies (https://cocoapods.org). Zap iOS uses CocoaPods in order to install and managed Swift/Objective-C dependencies.

If you would to update a pod to a newer version, make the appropriate changes in the `Podfile` and then run the following command:

`pod update [PODNAME]`

##### SwiftLint
#### SwiftLint

Enforce Swift style and conventions (https://github.com/realm/SwiftLint)

##### SwiftGen
#### SwiftGen

Code generator for your assets, storyboards, Localizable.strings (https://github.com/SwiftGen/SwiftGen)
Generates three files in the Library framework:
Expand All @@ -36,28 +45,12 @@ Generates three files in the Library framework:
* StoryboardScenes.swift
* Strings.swift

##### CocoaPods

For managing dependencies (https://cocoapods.org)

Zap iOS uses CocoaPods in order to install and managed the swift/Objective-C dependencies. To install the CocoaPods managed dependencies, run the following command:

```
bundle exec pod install
```

This command guarantees that the version of CocoaPods specified in the `Gemfile.lock` is used to `pod install` the dependencies listed in the `Podfile.lock`.

If you would to update a pod to a newer version, make the appropriate changes in the `Podfile` and then run the following command:

```
pod update [PODNAME]
```

##### Fastlane
#### Fastlane

For automating the development and release process (https://fastlane.tools)

---

### Build Configurations

We currently support two ways of connecting to `lnd`:
Expand Down