Skip to content

Commit 8133647

Browse files
authored
Merge pull request #14903 from wordpress-mobile/update-readme-build-install-test-instructions
Docs: Update `README.md` and `config-style.md` Docs to Reflect Recent Build Update
2 parents 0ef9a6f + 31947df commit 8133647

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,32 +46,32 @@ Once you've created your application in the [applications manager][5], you'll
4646
need to edit the `./gradle.properties` file and change the
4747
`wp.oauth.app_id` and `wp.oauth.app_secret` fields. Then you can compile and
4848
run the app on a device or an emulator and try to login with a WordPress.com
49-
account. Note that authenticating to WordPress.com via Google is not supported
49+
account. Note that authenticating to WordPress.com via Google is not supported
5050
in development builds of the app, only in the official release.
5151

52-
Note that credentials created with our [WordPress.com applications manager][5]
53-
allow login only and not signup. New accounts must be created using the [official app][1]
54-
or [on the web](https://wordpress.com/start). Login is restricted to the WordPress.com
55-
account with which the credentials were created. In other words, if the credentials
56-
were created with foo@email.com, you will only be able to login with foo@email.com.
57-
Using another account like bar@email.com will cause the `Client cannot use "password" grant_type` error.
52+
Note that credentials created with our [WordPress.com applications manager][5]
53+
allow login only and not signup. New accounts must be created using the [official app][1]
54+
or [on the web](https://wordpress.com/start). Login is restricted to the WordPress.com
55+
account with which the credentials were created. In other words, if the credentials
56+
were created with foo@email.com, you will only be able to login with foo@email.com.
57+
Using another account like bar@email.com will cause the `Client cannot use "password" grant_type` error.
5858

59-
For security reasons, some account-related actions aren't supported for development
59+
For security reasons, some account-related actions aren't supported for development
6060
builds when using a WordPress.com account with 2-factor authentication enabled.
6161

6262
Read more about [OAuth2][6] and the [WordPress.com REST endpoint][7].
6363

64-
## Build and Test ##
64+
## Build and Test ##
6565

6666
To build, install, and test the project from the command line:
6767

68-
$ ./gradlew assembleVanillaDebug # assemble the debug .apk
69-
$ ./gradlew installVanillaDebug # install the debug .apk if you have an
70-
# emulator or an Android device connected
71-
$ ./gradlew :WordPress:testVanillaDebugUnitTest # assemble, install and run unit tests
72-
$ ./gradlew :WordPress:connectedVanillaDebugAndroidTest # assemble, install and run Android tests
68+
$ ./gradlew assembleWordPressVanillaDebug # assemble the debug .apk
69+
$ ./gradlew installWordPressVanillaDebug # install the debug .apk if you have an
70+
# emulator or an Android device connected
71+
$ ./gradlew :WordPress:testWordPressVanillaDebugUnitTest # assemble, install and run unit tests
72+
$ ./gradlew :WordPress:connectedWordPressVanillaDebugAndroidTest # assemble, install and run Android tests
7373

74-
## Directory structure ##
74+
## Directory structure ##
7575
.
7676
├── libs # dependencies used to build debug variants
7777
├── tools # script collection
@@ -114,7 +114,7 @@ If you have questions or just want to say hi, join the [WordPress Slack](https:/
114114
- [Pull Request Guidelines](docs/pull-request-guidelines.md) - branch naming and how to write good pull requests
115115
- [Subtree'd Library Projects](docs/subtreed-library-projects.md) - how to deal with subtree dependencies
116116

117-
Please read the [docs](docs/) for more.
117+
Please read the [docs](docs/) for more.
118118

119119
## Resources
120120

docs/coding-style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Our code style guidelines are based on the [Android Code Style Guidelines for Co
55
* Line length is 120 characters
66
* FIXME must not be committed in the repository use TODO instead. FIXME can be used in your own local repository only.
77

8-
On top of the Android linter rules (best run for this project using `./gradlew lintVanillaRelease`), we use two linters: [Checkstyle](http://checkstyle.sourceforge.net/) (for Java and some language-independent custom project rules), and [ktlint](https://github.com/pinterest/ktlint) (for Kotlin).
8+
On top of the Android linter rules (best run for this project using `./gradlew lintWordPressVanillaRelease`), we use two linters: [Checkstyle](http://checkstyle.sourceforge.net/) (for Java and some language-independent custom project rules), and [ktlint](https://github.com/pinterest/ktlint) (for Kotlin).
99

1010
## Checkstyle
1111

0 commit comments

Comments
 (0)