How to add a new device to the wiki

Requirements for adding a device

The LineageOS wiki provides instructions based on the assumption that your device has got its device tree/kernel under the LineageOS GitHub organization, and that it supports building Lineage 13.0 or higher. If your device meets both those requirements, follow the instructions below to get your device set up.

Setting up the wiki locally

See contributing using repo for detailed instructions on setting up the wiki locally.

Adding your device

Prepare the required files

There are a few files which need to be there to have a device on the wiki. In order to get them, navigate to $LINEAGE_SRC/lineage/wiki/ and run:

./scripts/generate_device.sh your_device

Obviously replace your_device with the codename of your device

Populating the YAML

The sample template has been copied to $LINEAGE_SRC/lineage/wiki/_data/devices/your_device.yml. Update the values to match your device. An explanation of poorly-named/confusing options is below:

• architecture: The CPU architecture of the device - for example, arm or arm64.
• carrier: If the device was released for a specific carrier, the name of that carrier. Otherwise, leave the line blank.
• cpu: The CPU type of the device - for example, Cortex A9 or Krait 300.
• download_boot: Instructions for booting the device into the mode used to install recovery. On most devices, this is fastboot mode.
• image: The image located under images/devices/ to use for this device. Instructions on adding an image are below.
• install_method: Used to determine the recovery install template to use. Templates can be found in _includes/templates/recovery_install_install_method.md.
• kernel: The repo name of the kernel - for example, android_kernel_oneplus_msm8974.
• network: The frequencies and channels for the various network technologies. You can look them up here. Keep the non-available technologies empty.

• peripherals: A list of peripherals available on the device, including, but not limited to those from the following list:

  3-axis Compass, 3D Accelerometer, 3D Gyroscope, A-GPS, Accelerometer, Ambient light, Ambient light sensor, Audio Coprocessor, Barometer, Color spectrum, Compass, Digital compass, Dual SIM, Dual front speakers, Dual side NFC, FM Radio, FM radio, Fingerprint reader, GLONASS, GPS, Gesture sensor, Gyroscope, HDMI, HDMI (TV-out via MHL A\V link), Hall sensor, Hardware keyboard, Heart rate sensor, Humidity, Hygrometer, IR blaster, Iceview Cases, Infrared sensor, Light sensor, MHL, MHL 2.0, Magnetic sensor, Mobility DisplayPort (MyDP), Motion Coprocessor, NFC, Pedometer, Proximity sensor, Qi wireless charging, RGB ambient light, RGB light sensor, SNS integration, Sensor hub, Temperature, Thermometer, USB OTG, Ultrasound proximity sensor
  

• tree: The repo name of the device tree - for example, android_device_oneplus_bacon.
• vendor_short: The vendor name used for the device tree - for example, oneplus.

Adding the device’s image

Find a reasonably high-quality image of your device, and add it to images/devices/<image>.png. The filename should match the entry in your YAML file.

Testing it works

Start the wiki on your local Jekyll server, and navigate to the devices list. Your device should be there. Click on it, and check that the info/install/build pages all seem correct.

Submitting your device

After verifying the device-specific pages, commit and upload your changes to Gerrit, and add the “Wiki Editors” group as reviewers.