Code Monkey home page Code Monkey logo

android_vendor_crdroidota's Introduction

crDroid OTA repo

In order for a device to be officially supported by crDroid, OTA information needs to be added. Please refer to the following "Readme" to get started"

1. Introduction

In order for a device to be OTA compliant, there are a few things to know.

1.1 XML structure

    <manufacturer id="Manufacturer">
        <DeviceCode>
            <maintainer>MaintainerName</maintainer>
            <devicename>DeviceName</devicename>
            <filename>FileName</filename>
            <buildtype>BuildType</buildtype>
            <download>DownloadLink</download>
            <changelog>ChangelogLink</changelog>
            <gapps>GappsLink</gapps>
            <forum>ForumLink</forum>
            <firmware>FirmwareLink</firmware>
            <modem>ModemLink</modem>
            <bootloader>BootloaderLink</bootloader>
            <recovery>RecoveryLink</recovery>
            <paypal>PaypalLink</paypal>
            <telegram>TelegramLink</telegram>
        </DeviceCode>
    </manufacturer>

1.2 Mandatory XML tags

  • Manufacturer - Add under existing manufacturer (create manufacturer if required)
  • DeviceCode - Device code name
  • MaintainerName - Maintainer name followed by prefered name in parenthesis
  • DeviceName - Device name (not code name)
  • FileName - Latest crdroid build name (OTA code parses date to check for new version - don't include file extension .zip)
  • BuildType - Nightly/Weekly/Final
  • DownloadLink - Official download folder url (from AFH) masked by bit.ly shortlinks
  • ChangelogLink - Changelog url (GitHub)
  • GappsLink - Google apps url (preferred: opengapps url)
  • ForumLink - Forum url for discussions and support (preferred: xda url)

All mandatory XML tags need to be there. Please leave blank in case some do not apply to you.

1.3 Optional XML tags

  • FirmwareLink - link for needed firmware
  • ModemLink - link for needed modem
  • BootloaderLink - link for needed bootloader
  • RecoveryLink - link for recommended recovery
  • PaypalLink - paypal url (for donations)
  • TelegramLink - telegram url (if you offer support via telegram - can be a group link or telegram.me link)

2 Guidelines

  • Check if manufacturer is already existing
  • Check if published link is official
  • Check if XML is intact
  • Check if no extra / missing spaces

3. How to

3.1 Initial support - first setup via pull request

  1. Fork this repo to your own GitHub
  2. Make proper changes accoring to the XML structure
  3. Submit a pull request to this repo (this way we validate that you understood the requirements and if all is good you'll be granted direct push access to this repo)

3.2 Initial support - after you got push access

  1. Clone this repo locally
git clone https://github.com/crdroidandroid/android_vendor_crDroidOTA -b 9.0
  1. Open file named update.xml and make changes based on the XML structure. You can also add your changelog_<device_codename>.txt file if you have it.
  2. Now with the files updated, commit your changes to this repo.
git add *
git commit #(this opens up your prefered text editor, so write a nice description like "added support for <device>")
git push #you may be prompted for your github username and password

3.3 Update builds

  1. Just open a terminal and change to the directory where you cloned this repo (android_vendor_crDroidOTA) and fetch updates from repo.
cd android_vendor_crDroidOTA
git fetch --all
git pull
  1. Make changes to update.xml and changelog, then push updates to repo.
git add *
git commit 
git push

4. Notice:

Due to the fact the XML does not accept "&" in tags, there is a need to shortlink your download links

android_vendor_crdroidota's People

Contributors

neobuddy89 avatar gwolf2u avatar firebird11 avatar soubhik-khan avatar hokiealumnus avatar beroid avatar root2raj avatar sysxda avatar muralivijay avatar baumertjohn avatar chineel avatar bhermes21 avatar althafvly avatar kligli avatar iamsaikat avatar brunowp8 avatar anisnoorudheen avatar eliminater avatar wloot avatar coldhans avatar hondajohn88 avatar saikiran2001 avatar digigoon avatar anush02198 avatar dasshubham762 avatar arunassain avatar amanrajoo7 avatar adithya2306 avatar granrage avatar ruturajjena avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.