Skip to content

Commit a665f35

Browse files
committed
Add README.md for Android client project
1 parent 1458fd3 commit a665f35

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-yellow.svg)](http://www.apache.org/licenses/LICENSE-2.0)
2+
[![Android CI](https://github.com/Polyhoot/android/actions/workflows/android.yml/badge.svg)](https://github.com/Polyhoot/android/actions/workflows/android.yml)
3+
# **Polyhoot Android client**
4+
5+
_A light-weight Android client for Polyhoot game. Written in **Kotlin** and made with **Material Design 3** and Android 12 **Dynamic Colors support**._
6+
7+
## _Screenshots_
8+
9+
<img src="https://i.imgur.com/P0IIMis.png" width="200"> <img src="https://i.imgur.com/81TD4Ce.png" width="200">
10+
<img src="https://i.imgur.com/eJCWVSk.png" width="200">
11+
<img src="https://i.imgur.com/hHzFFGz.png" width="200">
12+
13+
## _Build Artifacts_
14+
15+
You can download **latest debug package** of the app from _GitHub Action Android CI workflow_ [**here**](https://github.com/Polyhoot/android/actions). Open latest successful action and download zipped APK file from the **Artifacts** section.
16+
17+
## _Getting Started_
18+
19+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
20+
21+
### _Prerequisites_
22+
23+
* Java Development Kit 17
24+
25+
### _Cloning_
26+
27+
```
28+
git clone https://github.com/polyhoot/android -b master
29+
```
30+
31+
### _Building_
32+
33+
Linux & macOS:
34+
```
35+
./gradlew build assembleDebug
36+
```
37+
38+
Windows:
39+
```
40+
.\gradlew.bat build assembleDebug
41+
```
42+
43+
### _Running on device_
44+
45+
Linux & macOS:
46+
```
47+
./gradlew build installDebug
48+
```
49+
50+
Windows:
51+
```
52+
.\gradlew.bat build installDebug
53+
```
54+
55+
## _Built with_
56+
57+
* [Android Studio](https://developer.android.com/studio) - Official Android IDE by Google & JetBrains
58+
* [Gradle](https://github.com/gradle/gradle) - Build automation tool
59+
* [Kotlin](https://kotlinlang.org/) - Official programming language for native Android apps
60+
* [Google Material Design 3 Components](https://m3.material.io/) - New default design language for Android 12+
61+
* [OkHttp](https://square.github.io/okhttp) - An HTTP client for handling WebSocket sessions
62+
63+
## _License_
64+
65+
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)