Wordpress-ios: Update README to be more clear

[kwonye]

We want to update the README to be more easily understood.

[kwonye]

Add @jkmassel as a reviewer

[apeatling]

rake dependencies installs all the dependencies from cocoapods, so there's no need to include the pod install step.

[apeatling]

There's no step to handle the scary red signing/provisioning profile errors you see when opening Xcode for the first time. I think this is only needed for an actual device though, but still important to mention it.

[kwonye]

Good point, let me look into if we can fix this. You should be able to build to a simulator without it however.

[apeatling]

It would be good to make the instructions short and a bulleted/numbered list. It'll be easier to follow each step.

[apeatling]

Also, setup credentials section is easy to miss. Once I built the app and it ran in the simulator, I would have missed that part unless @kwonye told me about it.

[jblz]

Is it worth mentioning that development happens in the develop branch? Some might find it confusing it's not in master.

[apeatling]

"Then edit the ~/.wpcom_app_credentials file and change the WPCOM_APP_ID and WPCOM_APP_SECRET fields to the values you got for your app."

It's not clear what "values you got for your app" means.

[kwonye]

Specify you need to create a new client AND a developer account vs just an account.

[jblz]

Is rake installed by default on MacOS or should we add a step to install it?

[apeatling]

Then edit the ~/.wpcom_app_credentials

this is not pointing to the right file based on previous steps.

[tcn33]

Suggested revision:

Third party tools

We use a few tools to help with development. To install or update the required dependencies, run the follow commands on the command line:

sudo gem install bundler
bundle install
rake dependencies

[apeatling]

There's a mismatch in terminology. Client ID vs WPCOM_APP_ID and Client Secret vs WPCOM_APP_SECRET. It would be good to be clear about the exact mapping.

[apeatling]

You need to clean the build folder in order for the credentials to take.

[kwonye]

Make more
explicit that you should use the same email as the developer account

[kwonye]

Make clear that you can't create an account in the app without the production client_id and app_secret

[tcn33]

rake dependencies installs all the dependencies from cocoapods, so there's no need to include the pod install step.

Is it possible to add rake git:install_hooks and rake lint or rake lint:autocorrect into rake dependencies as well?

[tcn33]

Warn that pod install might take a while on first run. Like, quite a while.

[kwonye]

From @apeatling: keep first issues up to date.

[tcn33]

Warn that xcode is a dependency for pod install in case people try to leap ahead.

[kwonye]

@apeatling ran into an issue with cocoapods-repo-update where he didn't have it installed initially. Maybe the rake dependencies install script isn't installing it right?

[tcn33]

Then edit the ~/.wpcom_app_credentials

this is not pointing to the right file based on previous steps.

Should be ~/.mobile-secrets/iOS/WPiOS/wpcom_app_credentials.

[tcn33]

Then you can compile and run the app on a device or an emulator and log in with a WordPress.com account.

This is a little bit "then draw the rest of the owl". Needs more steps.

[jblz]

There's an asterisk (*) at the end of the top / XCode section that currently says:

At the moment WordPress for iOS uses Swift 4.2 and requires Xcode 10 or newer. Previous versions of Xcode can be downloaded from Apple.*

I would expect that there would be some additional context in a footnote or something, but that doesn't seem to be the case.

[stale[bot]]

This issue has been marked as stale because:

• It has been inactive for the past year.
• It isn't in a project or a milestone.
• It hasn’t been labeled [Pri] Blocker, [Pri] High, or good first issue.

Please comment with an update if you believe this issue is still valid or if it can be closed. This issue will also be reviewed for validity and priority (cc @designsimply).

[apeatling]

@designsimply Did all of these issues get addressed? There's a lot of simple readme updates here that would significantly help external contributors to the apps (or increase the number of them from near zero).

[stale[bot]]

This issue has been marked as stale because:

• It has been inactive for the past year.
• It isn't in a project or a milestone.
• It hasn’t been labeled [Pri] Blocker, [Pri] High, or good first issue.

Please comment with an update if you believe this issue is still valid or if it can be closed. This issue will also be reviewed for validity and priority during regularly scheduled triage sessions.

[kwonye]

@apeatling I say close it 😉 Going through it, it looks pretty damn good.

Hope y'all are doing well!