Skip to content

Commit b85e12e

Browse files
committed
chore: update readme
1 parent dd80888 commit b85e12e

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

README.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
1-
# Bitkit Android
1+
# Bitkit Android (Native)
22

3-
Bitkit Android Native app.
3+
> [!CAUTION]
4+
> ⚠️This **NOT** the repository of the Bitkit app from the app stores!
5+
> The Bitkit app repository is here: **[github.com/synonymdev/bitkit](https://github.com/synonymdev/bitkit)**
6+
7+
---
8+
9+
## About
10+
11+
This repository contains a **new native Android app** which is **not ready for production**.
412

513
## Prerequisites
614

715
1. Download `google-services.json` to `./app` from FCM Console
8-
2. Run Polar with the default initial network
916

10-
## Dev Tips
11-
12-
- To communicate from host to emulator use:
13-
`127.0.0.1` and setup port forwarding via ADB, eg. `adb forward tcp:9777 tcp:9777`
14-
- To communicate from emulator to host use:
15-
`10.0.2.2` instead of `localhost`
17+
## Development
1618

1719
### Linting
1820

19-
This project uses detekt with default ktlint and compose-rules for linting Kotlin and Compose code.
21+
This project uses detekt with default ktlint and compose-rules for android code linting.
2022

2123
Recommended Android Studio plugins:
2224
- EditorConfig
@@ -28,29 +30,31 @@ Recommended Android Studio plugins:
2830
./gradlew detekt # run analysis + formatting check
2931
./gradlew detekt --auto-correct # auto-fix formatting issues
3032
```
31-
Lint reports are generated in: `app/build/reports/detekt/`.
33+
Reports are generated in: `app/build/reports/detekt/`.
3234

3335
## Localization
3436
See repo: https://github.com/synonymdev/bitkit-transifex-sync
3537

36-
## Bitcoin Networks
38+
### Build
39+
40+
### Bitcoin Networks
3741
The build config supports building 3 different apps for the 3 bitcoin networks (mainnet, testnet, regtest) via the 3 build flavors:
38-
- dev flavour = regtest
39-
- mainnet flavour = mainnet
40-
- tnet flavour = testnet
42+
- `dev` flavour = regtest
43+
- `mainnet` flavour = mainnet
44+
- `tnet` flavour = testnet
4145

42-
## Build for Release
46+
### Build for Release
4347

4448
**Prerequisite**: setup the signing config:
45-
- Add the keystore file to root, eg. `./release.keystore`
46-
- Add `keystore.properties` to root of the project (see `keystore.properties.template`)
49+
- Add the keystore file to root dir (i.e. `./release.keystore`)
50+
- Setup `keystore.properties` file in root dir (`cp keystore.properties.template keystore.properties`)
4751

48-
### Routine:
52+
#### Routine:
4953
Increment `versionCode` and `versionName` in `app/build.gradle.kts`, then run:
5054
```sh
5155
./gradlew assembleDevRelease
5256
# ./gradlew assembleRelease # for all flavors
5357
```
5458

55-
APK is generated in `app/build/outputs/apk/_flavor_/release`. (_flavor_ can be any of 'dev', 'mainnet', 'tnet').
59+
APK is generated in `app/build/outputs/apk/_flavor_/release`. (`_flavor_` can be any of 'dev', 'mainnet', 'tnet').
5660
Example for dev: `app/build/outputs/apk/dev/release`

0 commit comments

Comments
 (0)