Skip to content

Commit f261bbe

Browse files
committed
cleanup readme file
1 parent 67c4245 commit f261bbe

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The project includes a shell script file `YTemplate.sh` which renames and restru
1111
- `./YTemplate.sh <package_name> <application_name>`.
1212

1313
Note: To run the shell script on Windows, one can run bash on ubuntu in Windows(starting from Windows 10).
14-
Type ` bash YTemplate.sh <package_name> <data_base_entity> <application_name>`. It will execute the script.
14+
Type ` bash YTemplate.sh <package_name> <application_name>`. It will execute the script.
1515

1616

1717
## Features
@@ -24,6 +24,7 @@ Type ` bash YTemplate.sh <package_name> <data_base_entity> <application_name>`.
2424
* Ktor for remote database connection.
2525
* Jacoco support for test report generation.
2626

27+
2728
### Architecture
2829
Y—Template follows MVVM architecture. Different modules support different layers of MVVM architecture.
2930

@@ -45,14 +46,14 @@ Y—Template follows MVVM architecture. Different modules support different laye
4546
![](singleModuleArchitecture.png)
4647

4748
### How to generate test report
48-
- Generating jacoco test report
49+
- Generating jacoco debug test report
4950
- Gradle command `clean build createMergedJacocoReport`
5051
- From Android Studio
5152
- Open gradle menu bar from Android Studio right side panel
5253
- Click on the gradle icon and
5354
- In command popup window type `clean build createMergedJacocoReport` and press enter
5455
- Wait for the execution completion,
55-
- After successful execution each module level execution report will be stored in 'module\build\reports\jacoco\html\index.html'.
56+
- After successful execution report will be stored in 'project\build\reports\jacoco\html\index.html'.
5657

5758
### How to generate dokka report
5859
- Gradle command single module `clean build dokkaHtml` for multi-module `clean build dokkaHtmlMultiModule`

gradle/libs.versions.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[versions]
22
# Define the dependency versions
33
#kotlin
4-
kotlinVersion = "1.8.20"
4+
kotlinVersion = "1.8.10"
55
kotlinJvmTarget = "11"
66
kotlinxCoroutines = "1.6.4"
77
kotlinxSerializationJson = "1.5.0"
@@ -13,7 +13,7 @@ androidGradlePlugin = "7.4.2"
1313
androidxComposeBom = "2023.03.00"
1414
androidxActivityCompose = "1.7.0"
1515
androidxAppCompat = "1.6.1"
16-
androidxComposeCompiler = "1.4.3"
16+
androidxComposeCompiler = "1.4.4"
1717
androidxCore = "1.9.0"
1818
androidxLifecycle = "2.6.1"
1919
androidxNavigation = "2.5.3"

renovate.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@
6161
],
6262
"//developer-notice": "Ignored dependencies because of a hard dependency constraint on testing and analytics library",
6363
"ignoreDeps": [
64+
"org.jetbrains.kotlin:kotlin-gradle-plugin",
6465
"androidx.annotation:annotation",
6566
"androidx.test.core-ktx",
6667
"androidx.test.core"

0 commit comments

Comments
 (0)