Skip to content

Commit eab09ac

Browse files
authored
Update README.md
1 parent 6509606 commit eab09ac

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# README
22

3-
This project shows how to build an android application with kotlin and some other useful libraries. It imports the [Meepo](https://github.com/nekocode/Meepo) library to create activity & broadcast routers. And use kotlin language sugars to make their usages simpler. For example:
3+
Create android kotlin app from template.
4+
5+
This template project imports the [Meepo](https://github.com/nekocode/Meepo) library to create activity & broadcast routers. And use kotlin language sugars to make their usages simpler. For example:
46

57
```kotlin
68
// Goto a new activity
@@ -21,14 +23,14 @@ registerLocalReceiver({ _, intent ->
2123
}, "ACTION_XXX", "ACTION_XXX2")
2224
```
2325

24-
Sending a network request is also simple:
26+
Sending a network request in this project is also simple:
2527

2628
```kotlin
2729
gankIoService().picApi.getMeiziPics(1, 0)
2830
// ...
2931
```
3032

31-
And it splits network operations into a submodule. And make tests for them. Such as:
33+
And the network operations are separated into a submodule. Some tests are created for them:
3234

3335
```kotlin
3436
class GankIoServiceTest {
@@ -54,4 +56,12 @@ In addition, it creates some extention methods for [AutoDispose](https://github.
5456
.subscribe()
5557
```
5658

57-
For more details, you can look at the code directly.
59+
For more details, you can look at the code of template directly.
60+
61+
## Creating
62+
63+
Make sure you have installed Python 3 and [requests](https://pypi.org/project/requests/) library before proceeding. And then pate the following command at a terminal, replace the `PROJECT_NAME` and `APP_PACKAGE_NAME` and execute it:
64+
65+
```
66+
python3 -c "$(curl -fsSL https://raw.githubusercontent.com/nekocode/create-android-kotlin-app/master/create-android-kotlin-app.py)" PROJECT_NAME APP_PACKAGE_NAME
67+
```

0 commit comments

Comments
 (0)