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

Update INSTALL.md for clarity #284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56b3291
update installation guide for clarity
zackshapiro Oct 11, 2019
8809f6c
readme and install updates
zackshapiro Oct 12, 2019
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
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,17 @@ Open source isn't just writing code. Zap could use your help with any of the fol
- Helping to manage issue priorities
- Fixing bugs/new features

### Issues

If any of that sounds cool to you, feel free to dive in! [Open an issue][issues] or submit a pull request.

If you would like to help contribute to the project, please see the [Contributing Guide](docs/CONTRIBUTING.md)
### Contribution Guide

If you would like to help contribute to the project, please see the [Contributing Guide](docs/CONTRIBUTING.md).

### Installation

And if you want to build the app yourself take a look at the [Installation Guide](docs/INSTALL.md)
And if you want to build the app yourself take a look at the [Installation Guide](docs/INSTALL.md).

## Maintainers

Expand Down
55 changes: 25 additions & 30 deletions docs/INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,41 @@

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 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`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you don't have to install pods. pod sources are committed to the repository (for the reasons mentioned here: https://stackoverflow.com/a/45587355).

all you have to do is run setup.sh and open Zap.xcworkspace

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh awesome, will update shortly


3) That's it! Make sure to open `Zap.xcworkspace` rather than `Zap.xcodeproj` so you're using the Xcode file with the integrated Pods.

---

### 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/

#### CocoaPods

```
bundle install
```
For managing dependencies (https://cocoapods.org). Zap iOS uses CocoaPods in order to install and managed Swift/Objective-C dependencies.

If you would like to learn more take a look at https://www.mokacoding.com/blog/ruby-for-ios-developers-bundler/
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]`

**Note:** If you have any issues with CocoaPods, first run `bundle install` to install dependencies located in the `Gemfile`.

##### 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 +47,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