balint1414/firka
1
0
Fork 0
forked from firka/firka
Code Pull Requests Activity

update docs

Browse Source
This commit is contained in:
4831c0
2026-03-05 09:06:26 +01:00
parent bf75f72bcd
commit b6bfef7715
2 changed files with 20 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
CONTRIBUTING.md
View File

@@ -1,35 +1,19 @@
# Flutter telepítése
A firka androidra való lebuildeléséhez kötelező a saját Flutter fork használata, illetve minden más fajta --release buildhez is.
A Flutter telepítéséhez a dokumentáció [itt](https://docs.flutter.dev/get-started/install) található.
A Flutter zip letöltése helyett a custom engine-t cloneold le ([https://git.firka.app/firka/flutter/](https://git.firka.app/firka/flutter/))
# Brotli
A firka brotlival compresseli a libflutter-t buildelés közben ezért szükséges a projekt
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
- Ne felejtsd el újraindítani az IDE-det illetve parancssorodat utánna hogy frissüljön a PATH
## Linux/MacOS
Telepítsd fel a brotli packaget a distro-d package managerével
A projekt jelenleg a 3.41.2-es Flutter SDK-t használja.
# Keystore
[Secrets dokumentáció](secrets/README.md)
# Flutter l10n
# Fileok generálása
Flutter l10n fileok generálása
Flutter l10n és egyéb fileok generálása
```shell
Flutter gen-l10n --template-arb-file app_hu.arb
$ cd firka # vagy firka_wear
$ dart run scripts/codegen.dart
```
# Android debug build
@@ -42,20 +26,10 @@ $ Flutter build apk --debug --target-platform android-arm,android-arm64,android-
# Android release build
A release buildhez közelező egy keystore használata, illetve a saját Flutter engineünk használata.
A release buildhez közelező egy keystore használata.
## Custom Flutter engine setupolása
## Release appbundle buildelése (firka és firka_wear)
```shell
$ git clone https://git.firka.app/firka/flutter
$ cd flutter
$ . dev/tools/envsetup.sh
$ gclient sync -D
$ ./dev/tools/build_release.sh
```
## Release apk buildelése
```shell
$ ./tools/linux/build_apk.sh main
$ ./build.sh
```

51
CONTRIBUTING_en.md
View File

@@ -1,41 +1,24 @@
# Installing flutter
# Installing Flutter
To build firka you will have to use our custom Flutter fork,
and to make a release build you will have to use our custom
flutter engine.
The documentation for installing flutter can be found [here](https://docs.flutter.dev/get-started/install).
Instead of downloading the regular flutter zip, clone it from ([https://git.firka.app/firka/flutter/](https://git.firka.app/firka/flutter/)).
# 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
Flutter installation documentation can be found [here](https://docs.flutter.dev/get-started/install).
The project currently uses Flutter SDK 3.41.2.
# Keystore
[Secrets docs](secrets/README_en.md)
[Secrets documentation](secrets/README.md)
# Flutter l10n
# Generating files
Generating flutter l10n files
Generating Flutter l10n and other files
```shell
flutter gen-l10n --template-arb-file app_hu.arb
$ cd firka # or firka_wear
$ dart run scripts/codegen.dart
```
# Android debug build
The dev build doesn't require using a custom keystore
The dev build does not require using a keystore
```shell
$ cd firka
$ flutter build apk --debug --target-platform android-arm,android-arm64,android-x64
@@ -43,20 +26,10 @@ $ flutter build apk --debug --target-platform android-arm,android-arm64,android-
# Android release build
The release build requires using a custom keystore and our custom flutter fork
The release build requires using a keystore.
## Setting up our flutter engine fork
## Building the release appbundle (firka and firka_wear)
```shell
$ git clone https://git.firka.app/firka/flutter
$ cd flutter
$ . dev/tools/envsetup.sh
$ gclient sync -D
$ ./dev/tools/build_release.sh
$ ./build.sh
```
## Building the release apk
```shell
$ ./tools/linux/build_apk.sh main
```