Skip to content

Commit 9f6592d

Browse files
authored
Update README.md
1 parent a9345e5 commit 9f6592d

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
# README
22

3-
Create android kotlin app from template.
3+
This is an android application template project built with kotlin language and some useful libraries. It provides a creator script to quickly create an project from template.
44

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:
5+
## Creating project
6+
7+
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:
8+
9+
```
10+
python3 -c "$(curl -fsSL https://raw.githubusercontent.com/nekocode/create-android-kotlin-app/master/create-android-kotlin-app.py)" PROJECT_NAME APP_PACKAGE_NAME
11+
```
12+
13+
## What is included
14+
15+
The 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:
616

717
```kotlin
818
// Goto a new activity
@@ -57,11 +67,3 @@ In addition, it creates some extention methods for [AutoDispose](https://github.
5767
```
5868

5969
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)