devices.droidian.org

The site has been built using hugo. The instructions to install hugo can be found here

Running the hugo server for development

The hugo server can be started locally using the command:

$ hugo serve -D

-D flag is provided used to allow draft pages to be included.

The site is up at http://localhost:1313 by default

Adding new device to list of supported devices

In order to work with support device pages, ensure that python is installed on your machine.The step by step guide to install python can be found here

• The scripts depends on the yaml and schema Python packages, hence you need to install them before using running the script.You can install the dependencies by running the command:

  pip install -r requirements.txt

The list of devices that are known to run droidian can to found at https:devices.droidian.org.If you wish to add a new device to the list you will have to add an entry manually in the content/_index.md. You could point to an external URL for installation guide or use the generate_device_pages.py script present within in the project to automatically generate the installation guide.The script generates guides in markdown(.md) file format. The guides are genrated based on the device specific YAML configuration files present inside data/supported-devices directory.

python generate_device_pages.py

In order to new automatically generate the installation guide add new file with .yaml file inside data/supported-devices directory. copy the contents of device_template.yml(present in same folder) into the recently created .yaml file. Now update the paramters in the .yaml as per your device.

These are the parameters used in codename.yml. Start each device entry with a -.

• manufacturer: manufacturer of the device
• name: name of the device
• codename: codename of the device
• support: official or community
• device_type: phone, tablet, etc
• halium_version: 9, 10, or 11
• fastboot_mode: button combination for booting in fastboot mode
• recovery_mode: button combination for booting in recovery mode
• ab_slot: True if the device has A/B slots, leave empty if not
• api_version: version of the android API used for the device
• arch: device architecture
• droidian_release: a link to the correspodning Droidian release
• droidian_required_build: some devices might need a specific build, links to the files can be specified here, otherwise leave emopty
• android*: base android version to install before Droidian
• vendor_zip*: a vendor package to be flashed as zip
• vendor_image*: a vendor image to be flashed as an image
• boot*: Droidian boot image
• recovery**: recommended recovery for the device
• adaptation*: adaptation package to be flashed as zip
• statuspage: a link to the porting status page of the device, leave empty if there is no page
• contact: each contact should start with a -, as it becomes a list. text: what the text should say, link: where the hyperlink should point to
• credit: also a list, each entry should start with a -. name: the name of the maintainer, link: maintainer's page
• command: a list of commands that need to be run after first boot, start each line of the commands with a -
• notes: additional considerations for the device, start each note with a -. A note contains a title entry and a text that contains the note itself
• port_status: please, see the device_template.yml file for details

* android, vendor_zip, vendor_image, and boot have multiple parts. The link contains the actual link to the file or release page; the text contains the string what the download link should say in the page; and the filename specifies the name of the file that identifies the file when flashing.

** recovery has two further entry called name and must_flash. name specifies the name of the recovery, e. g., TWRP or Orange Fox Recovery; if must_flash is set to True, the user will be prompted to flash the recovery instead of just booting it (some devices have been reported to not support directly booting to the recovery image)