update documentation

This commit is contained in:
Osman Faruk Bayram 2025-11-02 18:42:30 +03:00
parent 77f2bb76d9
commit 886e226db5
6 changed files with 40 additions and 2 deletions

View file

@ -17,7 +17,7 @@ $ nix build --print-out-paths github:osbm/nixapks#smouldering_durtles
- [ ] Add first ionic app. - [ ] Add first ionic app.
- [ ] Add documentation on github pages. - [ ] Add documentation on github pages.
- [ ] Add binary cache - [ ] Add binary cache
- [ ] Design a proper meta field for the needs of android apps. - [ ] Design a proper meta field for the needs of android apps.
- [ ] description - [ ] description
- [ ] license - [ ] license
- [ ] main page - [ ] main page
@ -27,7 +27,7 @@ $ nix build --print-out-paths github:osbm/nixapks#smouldering_durtles
- [ ] abi (list of supported abis: armeabi-v7a, arm64-v8a, x86, x86_64) - [ ] abi (list of supported abis: armeabi-v7a, arm64-v8a, x86, x86_64)
- [ ] packageName (the unique identifier of the app, e.g. com.example.app) - [ ] packageName (the unique identifier of the app, e.g. com.example.app)
## Create checks ## Create checks
- [ ] Check if the apk can be installed (hopefully on multiple architectures) - [ ] Check if the apk can be installed (hopefully on multiple architectures)
- [ ] Check the meta field - [ ] Check the meta field

14
docs/src/SUMMARY.md Normal file
View file

@ -0,0 +1,14 @@
# Summary
[Introduction](README.md)
# Nixapks Guide
- [Building an App](building-an-app.md)
- [Analyzing an APK File](analyzing-an-apk-file.md)
- [Adding a New App](adding-a-new-app.md)
- [Updating an App](updating-an-app.md)
<!--
# Android Development with Nix
- [Frameworks and Tools](android-frameworks-and-tools.md) -->

View file

View file

@ -0,0 +1,15 @@
# Analyzing an APK File
First build the app
```sh
nix build .#mihon
```
Then use `apktool` to decode the APK file
```sh
nix run nixpkgs#apktool -- d result
```

View file

@ -0,0 +1,9 @@
# Building an App
Building an app is as easy as:
```sh
nix build .#app-name
```

View file