forked from firka/firka
docs: minor fixes and english docs
This commit is contained in:
@@ -9,8 +9,8 @@ buildeléséhez hogy a brotli a PATH-ben legyen
|
||||
|
||||
## Windows
|
||||
- Töltsd le a `brotli-x64-windows-static.zip`-et a [google/brotli github repoból](https://github.com/google/brotli/releases/latest)
|
||||
- Csomagold ki valahol (pl. C:\Users\<username>\dev\brotli)
|
||||
- Add hozzá a mappát ahova kicsomagoltad (C:\Users\<username>\dev\brotli) a PATH-hez
|
||||
- Csomagold ki valahol (pl. C:\Users\\<username>\dev\brotli)
|
||||
- Add hozzá a mappát ahova kicsomagoltad (C:\Users\\<username>\dev\brotli) a PATH-hez
|
||||
- Ne felejtsd el újraindítani az IDE-det illetve parancssorodat utánna hogy frissúljön a PATH
|
||||
|
||||
## Linux/MacOS
|
||||
@@ -53,5 +53,5 @@ $ ./dev/tools/build_release.sh
|
||||
## Release apk buildelése
|
||||
|
||||
```shell
|
||||
$ ./tools/linux/build_apk.sh
|
||||
$ ./tools/linux/build_apk.sh main
|
||||
```
|
||||
57
CONTRIBUTING_en.md
Normal file
57
CONTRIBUTING_en.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# Installing flutter
|
||||
|
||||
The documentation for installing flutter can be found [here](https://docs.flutter.dev/get-started/install).
|
||||
|
||||
# Brotli
|
||||
|
||||
Firka uses brotli to compress libflutter during the build process to make the app smaller,
|
||||
so building Firka requires you to have brotli in your path
|
||||
|
||||
## Windows
|
||||
- Download `brotli-x64-windows-static.zip` from [google/brotli](https://github.com/google/brotli/releases/latest)
|
||||
- Extract it to somewhere like C:\Users\\<username>\dev\brotli
|
||||
- Add the directory (ex. C:\Users\\<username>\dev\brotli) to your PATH
|
||||
- Don't forget to restart your IDE or terminal sessions for the PATH variable to update
|
||||
|
||||
## Linux/MacOS
|
||||
Install it using your distro's package manager
|
||||
|
||||
# Keystore
|
||||
|
||||
[Secrets docs](secrets/README_en.md)
|
||||
|
||||
# Flutter l10n
|
||||
|
||||
Generating flutter l10n files
|
||||
|
||||
```shell
|
||||
flutter gen-l10n --template-arb-file app_hu.arb
|
||||
```
|
||||
|
||||
# Android debug build
|
||||
|
||||
The dev build doesn't require using a custom keystore
|
||||
```shell
|
||||
$ cd firka
|
||||
$ flutter build apk --debug --target-platform android-arm,android-arm64,android-x64
|
||||
```
|
||||
|
||||
# Android release build
|
||||
|
||||
The release build requires using a custom keystore and our custom flutter fork
|
||||
|
||||
## Setting up our flutter engine fork
|
||||
|
||||
```shell
|
||||
$ git clone https://git.firka.app/firka/flutter
|
||||
$ cd flutter
|
||||
$ . dev/tools/envsetup.sh
|
||||
$ gclient sync -D
|
||||
$ ./dev/tools/build_release.sh
|
||||
```
|
||||
|
||||
## Building the release apk
|
||||
|
||||
```shell
|
||||
$ ./tools/linux/build_apk.sh main
|
||||
```
|
||||
@@ -1,5 +1,8 @@
|
||||
# Firka Napló
|
||||
|
||||
| <sub>HU</sub> [Magyar](README.md) | <sub>EN</sub> [English](README_en.md) |
|
||||
|-----------------------------------|---------------------------------------|
|
||||
|
||||
[](https://crowdin.com/project/firka)
|
||||
|
||||
## A projektről
|
||||
|
||||
13
README_en.md
Normal file
13
README_en.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# Firka
|
||||
|
||||
| <sub>HU</sub> [Magyar](README.md) | <sub>EN</sub> [English](README_en.md) |
|
||||
|-----------------------------------|---------------------------------------|
|
||||
|
||||
[](https://crowdin.com/project/firka)
|
||||
|
||||
## The project
|
||||
|
||||
Firka is an alternative client for [an application to be named]. The app's goal is to be a modern
|
||||
user friendly app for the [to be named] system.
|
||||
|
||||
[Contribution guide](CONTRIBUTING_en.md)
|
||||
40
secrets/README_en.md
Normal file
40
secrets/README_en.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# hogyan hozz létre upload-keystore-t flutterhez?
|
||||
|
||||
ha ezt olvasod, akkor valószínűleg szeretnéd a refilc appot build-elni. ha bármi kérdésed lenne, nyugodtan keress minket discordon, vagy akár emailben is!
|
||||
|
||||
## 1. keystore létrehozása
|
||||
|
||||
először, nyiss egy terminált ebben a mappában és futtasd ezt a parancsot:
|
||||
|
||||
```sh
|
||||
keytool -genkeypair -v \
|
||||
-keystore upload-keystore.jks \
|
||||
-keyalg RSA -keysize 2048 -validity 10000 \
|
||||
-alias upload
|
||||
```
|
||||
|
||||
ezután meg kell adnod néhány adatot:
|
||||
- egy jelszót a keystore-hoz (ezt jegyezd meg!)
|
||||
- nevedet, szervezeted nevét (nyugodtan hagyhatod alapértelmezetten)
|
||||
- egy második jelszót az „upload” aliashoz (ajánlott az előzőt használni)
|
||||
|
||||
ha minden jól megy, egy `upload-keystore.jks` fájl létrejön.
|
||||
|
||||
## 3. keystore.properties létrehozása
|
||||
|
||||
hozz létre egy új fájlt `keystore.properties` néven, és írd bele a következőt:
|
||||
|
||||
```properties
|
||||
storeFile=upload-keystore.jks
|
||||
storePassword=password
|
||||
keyPassword=password
|
||||
keyAlias=upload
|
||||
```
|
||||
|
||||
cseréld ki a `password` részeket, természetesen a választott jelszavadra.
|
||||
|
||||
## 4. secrets mappa kizárása a gitből
|
||||
|
||||
már beleraktuk a .gitignore mappába a kizárását ennek, ezen nem kell aggódnod.
|
||||
|
||||
készen is vagy, sok sikert!
|
||||
Reference in New Issue
Block a user