mirror of
https://github.com/Dr-Blank/Vaani.git
synced 2026-02-10 19:39:34 +00:00
feat: add Linux build guide and enhance make_config.yaml with detailed description and features
This commit is contained in:
parent
140a644c06
commit
6dbfc3fbfe
2 changed files with 62 additions and 2 deletions
45
docs/linux_build_guide.md
Normal file
45
docs/linux_build_guide.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
# Linux Build Guide
|
||||
|
||||
## Determining Package Size
|
||||
To determine the installed size for your Linux package configuration, you can use the following script:
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
|
||||
# Build the Linux app
|
||||
flutter build linux
|
||||
|
||||
# Get size in KB and add 17% buffer for runtime dependencies
|
||||
SIZE_KB=$(du -sk build/linux/x64/release/bundle | cut -f1)
|
||||
BUFFER_SIZE_KB=$(($SIZE_KB + ($SIZE_KB * 17 / 100)))
|
||||
|
||||
echo "Actual bundle size: $SIZE_KB KB"
|
||||
echo "Recommended installed_size (with 17% buffer): $BUFFER_SIZE_KB KB"
|
||||
```
|
||||
|
||||
Save this as `get_package_size.sh` in your project root and make it executable:
|
||||
```bash
|
||||
chmod +x get_package_size.sh
|
||||
```
|
||||
|
||||
### Usage
|
||||
1. Run the script:
|
||||
```bash
|
||||
./get_package_size.sh
|
||||
```
|
||||
2. Use the output value for `installed_size` in your `linux/packaging/deb/make_config.yaml` file:
|
||||
```yaml
|
||||
installed_size: 75700 # Replace with the value from the script
|
||||
```
|
||||
|
||||
### Why add a buffer?
|
||||
The 17% buffer is added to account for:
|
||||
- Runtime dependencies
|
||||
- Future updates
|
||||
- Potential additional assets
|
||||
- Prevent installation issues on systems with limited space
|
||||
|
||||
### Notes
|
||||
- The installed size should be specified in kilobytes (KB)
|
||||
- Always round up the buffer size to be safe
|
||||
- Re-run this script after significant changes to your app (new assets, dependencies, etc.)
|
||||
|
|
@ -15,6 +15,20 @@ essential: false
|
|||
|
||||
icon: assets/icon/logo.png
|
||||
|
||||
description:
|
||||
short: Beautiful, Fast and Functional Audiobook Player for your Audiobookshelf server.
|
||||
long: |
|
||||
Vaani is a client for your (self-hosted) Audiobookshelf server.
|
||||
|
||||
Features:
|
||||
- Functional Player: Speed Control, Sleep Timer, Shake to Control Player
|
||||
- Save data with Offline listening and caching
|
||||
- Material Design
|
||||
- Extensive Settings to customize every tiny detail
|
||||
|
||||
Note: you need an Audiobookshelf server setup for this app to work.
|
||||
Please see https://www.audiobookshelf.org/ on how to setup one if not already.
|
||||
|
||||
postuninstall_scripts:
|
||||
- echo "Sorry to see you go."
|
||||
|
||||
|
|
@ -26,8 +40,9 @@ keywords:
|
|||
generic_name: Audiobook Player
|
||||
|
||||
categories:
|
||||
- Media
|
||||
- Utility
|
||||
- AudioVideo
|
||||
- Audio
|
||||
- Player
|
||||
|
||||
startup_notify: true
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue