Attics icon indicating copy to clipboard operation
Attics copied to clipboard

Add "Getting Started" instructions in the README

Open zacwood9 opened this issue 5 years ago • 2 comments

Useful to new contributors. Let's try to be professionals 😉

zacwood9 avatar Jul 13 '19 18:07 zacwood9

hi, new to github here and looking to contribute to a few projects. are you looking for someone to write instructions on how to download the app, or is there more to it?

deannathompson avatar Jul 13 '19 23:07 deannathompson

Hey! It would be nice to have instructions for

  1. cloning the repo
  2. building the dependencies with Carthage
  3. running the app in Xcode

1 and 3 are pretty straightforward but not many apps use Carthage to manage dependencies, so that's probably what would confuse people the most. Let me know if you have any other questions!

zacwood9 avatar Jul 14 '19 01:07 zacwood9