Skip to content

Commit 435cd07

Browse files
committed
Update README.md to match current project state
Signed-off-by: Arseniy Graur <argraur@gmail.com>
1 parent 7643171 commit 435cd07

File tree

1 file changed

+38
-21
lines changed

1 file changed

+38
-21
lines changed

README.md

Lines changed: 38 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,47 @@
11
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-yellow.svg)](http://www.apache.org/licenses/LICENSE-2.0)
22
[![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**
43

5-
_A light-weight Android client for Polyhoot game. Written in **Kotlin** and made with **Material Design 3** and Android 12 **Dynamic Colors support**._
4+
# **Polyhoot! Android client**
65

7-
## _Download latest release_
8-
Polyhoot! is being distributed through **Firebase App Distribution**.
9-
You can use this link to get releases: [**Firebase App Distribution Invitation**](https://appdistribution.firebase.dev/i/2817cf40c50c4feb)
6+
<img width="100" height="100" alt="Polyhoot! Logo"
7+
src="https://github.com/Polyhoot/.github/blob/main/logo.jpeg?raw=true" align="right">
108

11-
## _Screenshots_
9+
### A light-weight Android client for Polyhoot! Written in _Kotlin_ and made with _Material 3_ and _Dynamic Colors support_.
10+
11+
## Download latest release
12+
13+
Polyhoot! is being distributed through **Firebase App Distribution**. You can use this link to get
14+
releases: [**Firebase App Distribution
15+
Invitation**](https://appdistribution.firebase.dev/i/2817cf40c50c4feb)
16+
17+
## Screenshots
1218

1319
<img src="https://i.imgur.com/P0IIMis.png" width="200"> <img src="https://i.imgur.com/81TD4Ce.png" width="200">
1420
<img src="https://i.imgur.com/eJCWVSk.png" width="200">
1521
<img src="https://i.imgur.com/hHzFFGz.png" width="200">
1622

17-
## _Build Artifacts_
23+
## Build Artifacts
1824

1925
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.
2026

21-
## _Getting Started_
27+
## Getting Started
2228

2329
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
2430

25-
### _Prerequisites_
31+
### Prerequisites
2632

2733
* Java Development Kit 17
34+
* Android SDK Manager
2835

29-
### _Cloning_
36+
### Cloning
3037

3138
```
3239
git clone https://github.com/polyhoot/android -b master
3340
```
3441

3542
### Using your own server
3643

37-
You can set WebSocket URL to your own server by editing `polyhoot.websocket.url` field
44+
You can set WebSocket URL to your own server by editing `polyhootWebSocketUrl` field
3845
in `app/gradle.properties`:
3946

4047
```
@@ -43,44 +50,54 @@ app/gradle.properties:
4350
/* ... */
4451
# Defines main entry point to polyhoot server infrastructure
4552
# Change this address if you want to run your own server.
46-
polyhoot.websocket.url=YOUR_URL_HERE
53+
polyhootWebSocketUrl=YOUR_URL_HERE
4754
/* ... */
4855
```
4956

50-
### _Building_
57+
### Setting up build environment
58+
59+
Open `local.properties` file and define path to Android SDK using `sdk.dir=` property For example:
60+
`local.properties`
61+
62+
```
63+
# Location of the SDK. This is only used by Gradle.
64+
sdk.dir=<path-to-sdk>
65+
```
66+
67+
### Building
5168

5269
Linux & macOS:
5370

5471
```
55-
./gradlew build assembleDebug
72+
./gradlew assembleDebug
5673
```
5774

5875
Windows:
5976

6077
```
61-
.\gradlew.bat build assembleDebug
78+
.\gradlew.bat assembleDebug
6279
```
6380

64-
### _Running on device_
81+
### Running on device
6582

6683
Linux & macOS:
6784
```
68-
./gradlew build installDebug
85+
./gradlew installDebug
6986
```
7087

7188
Windows:
7289
```
73-
.\gradlew.bat build installDebug
90+
.\gradlew.bat installDebug
7491
```
7592

76-
## _Built with_
93+
## Built with
7794

7895
* [Android Studio](https://developer.android.com/studio) - Official Android IDE by Google & JetBrains
7996
* [Gradle](https://github.com/gradle/gradle) - Build automation tool
8097
* [Kotlin](https://kotlinlang.org/) - Official programming language for native Android apps
8198
* [Google Material Design 3 Components](https://m3.material.io/) - New default design language for Android 12+
8299
* [OkHttp](https://square.github.io/okhttp) - An HTTP client for handling WebSocket sessions
83100

84-
## _License_
101+
## License
85102

86-
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
103+
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)