Skip to content

Commit

Permalink
docs: Include info about updating gradle.lockfile in README
Browse files Browse the repository at this point in the history
  • Loading branch information
devinbileck committed Jan 27, 2024
1 parent 1cda5c8 commit a647c8e
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,30 @@ Since Bisq is a desktop-based application, this Android app enables you to pair
application and receive important notifications such as trade updates and offer alerts when you are
not near your computer.

## Updating Gradle Verification Metadata
## Prerequisites

Whenever dependencies change, it is necessary to update the contents of
`gradle/verification-metadata.xml`. This can be done automatically using the following command.
In order to pair the app and receive notifications, you will need to obtain an appropriate
`google-services.json` file and place it under the app/ directory. Refer to
[firebase documentation](https://firebase.google.com/docs/android/setup#add-config-file)
for more information.

## Updating Gradle Dependency Locks and Verification Metadata

Whenever dependencies are changed, it is necessary to update the following:

- `gradle/verification-metadata.xml` - this can be updated using the following command:

```shell
./gradlew --write-verification-metadata sha256 build :app:connectedDebugAndroidTest
```

> Using the `:app:connectedDebugAndroidTest` task ensures that all dependencies are updated.
## How to Run
- `gradle.lockfile` - this can be updated using the following command:

In order to pair the app and receive notifications, you will need to create your own
`google-services.json` file and place it under the app/ directory. Refer to
[firebase documentation](https://firebase.google.com/docs/android/setup#add-config-file)
for more information.
```shell
./gradlew dependencies --write-locks
```

## Architectural Design

Expand Down

0 comments on commit a647c8e

Please sign in to comment.