mirror of
https://github.com/NoCrypt/migu.git
synced 2026-04-21 00:22:08 +00:00
readme: add instruction for building
This commit is contained in:
parent
5685d942e3
commit
6f846c7421
1 changed files with 44 additions and 8 deletions
52
README.md
52
README.md
|
|
@ -17,17 +17,53 @@
|
|||
- **Separate Download and Upload Limits:** Allows setting different limits for downloading and uploading. Give user more control.
|
||||
|
||||
### Mobile Focused Fixes
|
||||
- Amoled Theme
|
||||
- Back button now function as back button (shocking I know)
|
||||
- Statusbar now function as statusbar (shocking I know)
|
||||
- Changing tabs will actually changing tab (shocking I know)
|
||||
- Reclicking Now Playing tab will close the modal
|
||||
- Play video on fullscreen by default instead of playing it in horizontal page
|
||||
|
||||
- **AMOLED Theme:** Adds a sleek, battery-saving dark theme for AMOLED displays.
|
||||
- **Back Button Functionality:** The back button now works as expected. *Shocking I know!* 🤯
|
||||
- **Status Bar Enhancement:** The status bar now displays and hides dynamically when playing video in fullscreen. *Shocking I know!* 🤯
|
||||
- **Improved Tab Navigation:** Changing tabs now reliably switches to the selected tab, closing any modals. *Shocking I know!* 🤯
|
||||
- **Modal Behavior:** Re-clicking the "Now Playing" tab will now close the modal.
|
||||
- **Fullscreen Video Playback:** Videos now play in fullscreen by default, enhancing the viewing experience.
|
||||
|
||||
|
||||
#### Why?
|
||||
Mobile users often have limited bandwidth or data quotas. Miru can consume up to 1GB per 3 minutes upon startup due to miniplayer, which is impractical for mobile users[.](https://rentry.org/miguarg)
|
||||
Mobile users often have limited bandwidth or data quotas. Miru can consume up to 1GB per 3 minutes upon startup due to miniplayer, which is impractical for mobile users since you might want to watch other anime but the miniplayer just keep running upon startup[.](https://rentry.org/miguarg)
|
||||
|
||||
|
||||
## **Building and Development**
|
||||
|
||||
<sub>[~~*dont.*~~](https://github.com/ThaUnknown/miru/#:~:text=Building%20and%20Development-,dont,-Dependencies%3A)</sub>
|
||||
|
||||
<u>***Please do! I highly encourage this!***</u>
|
||||
|
||||
|
||||
### Requirements
|
||||
- PNPM (any packgage manager will do)
|
||||
- Nodejs LTS
|
||||
- Docker (with WSL support if you're on windows)
|
||||
- ADB
|
||||
- Android Studio (with SDK 33, **EXACTLY 33**, no more no less)
|
||||
|
||||
### Preparation
|
||||
- `pnpm install`
|
||||
|
||||
### Building for PC (electron)
|
||||
- `cd electron`
|
||||
- `pnpm install`
|
||||
- Development: `pnpm start`
|
||||
- Release: `pnpm build`
|
||||
|
||||
### Building for Android (capacitor)
|
||||
- `cd capacitor`
|
||||
- `pnpm install`
|
||||
- Check what's missing: `pnpm exec capacitor doctor`
|
||||
- Windows: `pnpm build:native-win` || Linux: `pnpm build:native`
|
||||
- (optional) Generate Assets: `pnpm dlx @capacitor/assets generate --iconBackgroundColor #20a2ff --iconBackgroundColorDark #20a2ff --splashBackgroundColor #20a2ff --splashBackgroundColorDark #20a2ff --android` (built-in forked capacitor/assets from this project didnt work for me)
|
||||
- `pnpm exec cap open android`
|
||||
- Connect your phone with ADB
|
||||
- Development: `pnpm build:web` then `pnpm start`
|
||||
- Release: `pnpm test:e2e`
|
||||
|
||||
## License
|
||||
|
||||
This project acknowledges and complies with the GPL license.
|
||||
This project acknowledges and complies with the GPLv3 license.
|
||||
Loading…
Reference in a new issue