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

Conversation

zackshapiro
Copy link

I made some small quality of life updates to INSTALL.md for clarity, nothing groundbreaking :)

Motivation and Context

I just want to make it easier for people to install and get started and have less questions for existing devs.

How Has This Been Tested?

I proof-read it 😄

Types of changes

Copy update

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@codecov-io
Copy link

Codecov Report

Merging #284 into master will decrease coverage by 0.11%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##           master    #284      +/-   ##
=========================================
- Coverage    7.53%   7.41%   -0.12%     
=========================================
  Files         219     219              
  Lines        8694    8694              
=========================================
- Hits          655     645      -10     
- Misses       8039    8049      +10
Impacted Files Coverage Δ
...htning/Services/Misc/BlockChainHeightUpdater.swift 60.41% <0%> (-20.84%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 52a8c41...56b3291. Read the comment docs.

docs/INSTALL.md Outdated Show resolved Hide resolved
#### 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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants