The goal of this tools is to kickstart an end-user's port to Mobile NixOS by automating part of the tedious work of searching for facts about their devices.
It will not produce instantly-bootable ports, but will vastly reduce the amount of intel gathering.
With the latest released version, in a checkout of Mobile NixOS:
$ pwd
.../Projects/mobile-nixos
$ nix-shell
[...]
[nix-shell] $ cd devices
[nix-shell] $ ./autoport.rb $OEM $DEVICE
[...]
[nix-shell] $ ls -l $OEM-$DEVICE
drwxr-xr-x 2 samuel users 4096 Sep 29 12:34 kernel
-rw-r--r-- 1 samuel users 1474 Sep 29 12:35 default.nix
-rw-r--r-- 1 samuel users 209 Sep 29 12:34 misc.json
-rw-r--r-- 1 samuel users 13692 Sep 29 12:34 oem_props.json
Where OEM and DEVICE represent values found (for the moment) at the Android Dumps project.
The output of this is a directory in your $PWD named $OEM-$DEVICE which
holds the skeleton generated files.
For the time being, it does not generate a skeleton for the kernel builder
derivation, as there is no "template" per se to use. Start from a
kernel/default.nix from another device with a similar kernel version or a
similar SoC.
I would heavily suggest making the first commit in your commit series the unmodified output of this tool, as a way to track required changes for this output to be useful.
Be mindful and read the /**/ comments! All of them are related to the
generation process! You will be asked to fill in some values that couldn't be
detected for the time being.
Be mindful about the device name!
It can happen that the name detected differs from the name of the data source used (Android Dumps).
It is likely that the detected name (mobile.device.name) is the preferred
name.
This current early version of the tool assumes the end-user will want to use data from the Android Dumps project.
They are semi-standardized pre-extracted repositories made from the OEM system images.
It does not require the end-user to trust the Android Dumps project, as it only gathers facts, and does not use any of the code.
This mainly allows this project to skip the tedious work of figuring out the diverse system image formats extraction procedures.
Extract different system image types ourselves to allow the end-user to work from an image they choose.
Such images could be a TWRP-like recovery, a LineageOS-like custom rom, or simply a system image they chose.