Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 2.01 KB

README.md

File metadata and controls

36 lines (23 loc) · 2.01 KB

Substratum Database

This is a collection of XML files and tools used by the Substratum team to keep supported ROMs and themes documented. There are two ways to get into this repo as a ROM developer and themer.

1. Pull requests

If you need some help starting a pull request, see this article.

For themers

Add your theme to the appropriate XML file. Please use the following template:

<theme id="THEME NAME">
    <author>YOUR NAME AS YOU WANT IT TO APPEAR</author>
    <link>DIRECT LINK TO YOUR THEME</link>
    <package>YOUR THEME'S PACKAGE IDENTIFIER</package>
    <pricing>Paid|free</pricing>
    <backgroundimage>https://raw.githubusercontent.com/substratum/database/master/images/IMAGE_NAME.ext</backgroundimage>
</theme>
  • For the backgroundimage tag, add your hero image from the Play Store into the Images folder and update the ending to be what your image is named.

Keep the themes in alphabetical order. Any themes NOT following these guidelines will be rejected.

For ROM developers

Please add your ROM name (as you want it to appear) and identification prop (it MUST be unique, ro.cm.version, ro.mod.version, ro.rom.version are not acceptable) into the Supported ROMs XML file. If you have no unique prop (I'd recommend making one), please include a keyword (again, unique to you) that we can pull from your /system/build.prop. Keep the list alphabetical and format the commit message as "ROMs: Add <your_rom_name>". Any issues with this and your pull request will be rejected.

2. Manual application

If you cannot create a pull request, please send an email to both Nathan Chancellor (nathan@prjkt.io) and Harsh Shandilya (harsh@prjkt.io) with the above information. Your request will be denied if ANY information is missing.

Questions?

Fill out an issue or post in the Substratum community and tag Nathan Chancellor.