You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+36-5
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,39 @@
1
1

2
+
2
3
# Klient
3
4
4
5
## Installing
6
+
5
7
### Android
6
-
Install it directly from the [Play store](https://play.google.com/store/apps/details?id=de.loicezt.klient) or go to the [Releases](https://github.com/lolocomotive/klient/releases) page and download the latest version (be sure to select the right architecture, if you're not sure what that means, just select the file with no specific architecture, which should look like that `klient-28eef2.apk`)
8
+
9
+
Go to the [Releases](https://github.com/lolocomotive/klient/releases) page and download the latest version (be sure to select the right architecture, if you're not sure what that means, just select the file with no specific architecture, which should look like that `klient-28eef2.apk` )
10
+
7
11
### iOS
12
+
8
13
The app is not available on iOS since I don't have a Macbook or an iPhone, which makes it impossible to build the app for iOS. Feel free to implement iOS support if you have the tools required to do so.
9
14
15
+
### Linux
16
+
17
+
Go to the [Releases](https://github.com/lolocomotive/klient/releases) page. The app is only available for x86_64. You can either choose the AppImage which should work everywhere or the .tar.gz, which is smaller but requires some libraries.
18
+
<details>
19
+
<summary>Installing the libraries on Ubuntu/Debian</summary>
Go to the [Releases](https://github.com/lolocomotive/klient/releases) page and download and extract the windows zip file. It should work on any x86_64 windows device.
28
+
29
+
### MacOS
30
+
31
+
The builds are not available *yet*, I might try to configure github actions to do it for me, since I don't own any Apple devices.
32
+
10
33
## Contributing
34
+
11
35
Any contributions (Pull requests, feature requests and bug reports) are very welcome!
12
-
Be aware that I set my line width to 100 instead of 80, so be careful before reformatting entire files. If you're using vscode put the following in `.vscode/settings.json`.
36
+
Be aware that I set my line width to 100 instead of 80, so be careful before reformatting entire files. If you're using vscode put the following in `.vscode/settings.json`.
13
37
14
38
```json
15
39
{
@@ -20,12 +44,14 @@ Be aware that I set my line width to 100 instead of 80, so be careful before ref
20
44
],
21
45
}
22
46
}
23
-
```
47
+
```
48
+
24
49
### Building
50
+
25
51
It's just a normal flutter project (refer to the flutter documentation on how to build). You may encounter issues if you are trying to build without the git repository.
26
52
27
53
<details>
28
-
<summary>Building for release</summary>
54
+
<summary>Building on Android for release</summary>
29
55
You'll need to create android/key.properties with your key's details
30
56
31
57
```properties
@@ -34,6 +60,7 @@ keyPassword=password123
34
60
storeFile=<path>/keystore.jks
35
61
storePassword=password123
36
62
```
63
+
37
64
Details on how to create a key are available on the [Android Developers website](https://developer.android.com/studio/publish/app-signing#generate-key)
38
65
39
66
</details>
@@ -42,7 +69,11 @@ Details on how to create a key are available on the [Android Developers website]
0 commit comments