[Rom Format] Devs please read - Nexus 4 Android Development

Below is a format that is a guideline to be used as an example of how a rom thread should look. It doesn't have to be exact. I suggest that you stay creative and use all the features in the advanced panel when creating a thread.
Name of rom, team, etc
Introduction
Changelog in code or list tags
What's included in the rom in the (apps, tweaks, scripts, addons, mods) in code or list tags
What works/what doesn't work in code or php tags
Credits (Users name-with link to (profile/github/or thread u got tweak from embedded), and what they did to help you)
Screenshots (2-10 different screenshots of different aspects of rom)
Kernel with either link to thread you got it from or github (if stock sense or cm please state that and that is enough)
Instructions on how to install the rom (also if special instruction for a2sd or beats audio...etc)
Do's and Don'ts of the rom
Questions & Answers section (I find this helpful to write out asked questions with solutions at the bottom of the op. I find that it cuts down on the question being asked a million times)
Finally the dl link
Additional add-ons (this can go into first post or reserved posts after)
I find the embedded link looks and feels better throughout the op if possible.
All sections should have a header with enlarged text and spaced out so people can read it easily.
I am hoping that this helps to make this section a little cleaner and easier. enjoy
The way I look at this is that it takes you weeks/days/hours to make these roms....we can take the time out to make sure that the op looks professional and clean
Not to toot my own horn but here is a link to one of my own rom threads as an example. Link
Also Make sure the op is fully ready before posting. I know we all get excited to release a rom but stating that half the stuff will be updated as time permits just shows that you are lazy and in a hurry which doesn't look good cause if thats the case then how does your rom run....
No posting a a rom thread without a DL link either. If posted then the thread will be removed

Thread title format
Just to add to Papa Smurf151's post, when posting something, please use this format for the title:
[What it is][last updated][Version+stable/test/beta/wip/etc]Name of rom/kernel/etc
For example:
[ROM] [15nov12] [4.3.1BETA] TheBestestKangedROMEver

Related

How To Create A Community Rom

Hey recentrly i made the " b6gsix gude for noobs: how to theme a rom " and one reply from a guy said SO YOU ARE TRYING TO MAKE A COMMUNITY ROM ?
i wasnt but thats sounds nice. ive seen one community rom b4 and i like the concept but im no dev lol so how do i go about doing so?
You don't. Don't hop right into making a ROM. You need to at least know how to program it. Let me quote something cyanogen said:
Here's my advice for those looking to make their own Android ROMs.. Stop. Write an app or two first, learn how the system works from a developer standpoint. Learn some Java. Read the developer documentation. Learn how to use Git. Then learn how to build AOSP from source. Read the porting guides, and learn how the build system works (the links below have almost everything you could possibly want to know). Now try to put your new found skills to work on enhancing the platform by writing code or making theme overlays. And share! And put that **** on your resume. There is a *ton* of information out there but any kind of "step-by-step rom cooking guide" is going to be a complete fail- it's too broad of a subject.
Android Developer Guides: http://d.android.com
Working with AOSP source: http://source.android.com
Platform Developer Guide: http://pdk.android.com
Android Gitweb: http://android.git.kernel.org
Git Ready (Git tips and tricks): http://www.gitready.com/
Building CyanogenMod: http://wiki.cyanogenmod.com/index.php/Building_from_source
How Dexopt works and what are those odex files: http://android.git.kernel.org/?p=pl...bcd225e47b2cc7abb2a366112d3aeb45936;hb=master
The PDK site is absolutely vital if you are going to work on custom ROMs. Read every single page. Twice. Some of the info isn't up to date, but you'll get a really good idea about what goes into actually configuring Android to work on a real device.
Click to expand...
Click to collapse
I'm seeing you're having problems themeing. Understandable - you're new. However, if you can't even theme, you need to just take it slow. Master Android deving little by little until you can write an app - as useful one at that - and can write it well.
As for starting a community ROM - I don't think many people will just hop on it with you if you yourself can't even program the ROM.

☞[WARNING: READ ME 1st] If YOU DID NOT CREATE "it" THEN IT DOESN'T BELONG IN HERE

☞[WARNING: READ ME 1st] If YOU DID NOT CREATE "it" THEN IT DOESN'T BELONG IN HERE
NOTICE: If You did not create the ROM, KERNEL, FIX, MOD, APP, HACK, GUIDE, or if it's not a SOURCE CODE then it should go to Nexus 4 General as it doesn't belong in Development.
If your thread can be phrased as a question, it DEFINITELY doesn't belong in Development either, post in in the Nexus Q & A sectionhttp://forum.xda-developers.com/forumdisplay.php?f=1909. If you post it in Development it will be moved/closed and you may get an infraction or a ban.
There is only 1 exception, stock ROMs are allowed, as long as the link does not require a registration to download the ROM.
You may start planning a [DEV] topic in the General or Q & A section and then have it moved to the Android Development section once the actual Development has started.
☞ Development is classified as original work and/or documented edits and changes made to others work (with their permission) that makes it your own.
Stock ROM dumps that are modified (deodexed, etc.) from the manufacturer's original intent and then repackaged together classifies as development.
Kernel's and Recovery obviously classify as development as they are modified and compiled from source
☞ Themes are graphical/visual changes made to a ROM which make's the ROM visually different from the original work, i.e. different battery icons, a blue-color scheme, etc. They may be packaged up together with a full ROM and deployed the same way. Simply running a script (not made by you) to deodex and then packaging other people's work/MOD's into one place does not constitute original development.
Follow the FORUM RULES and the XDA MANTRA and we'll all get along and enjoy this community!
Thank you for your cooperation & thanks to jerdog for writing this wonderful explanation.

☞[WARNING: READ ME 1st] If YOU DID NOT CREATE "it" THEN IT DOESN'T BELONG IN HERE

☞[WARNING: READ ME 1st] If YOU DID NOT CREATE "it" THEN IT DOESN'T BELONG IN HERE
NOTICE: If You did not create the ROM, KERNEL, FIX, MOD, APP, HACK, GUIDE, or if it's not a SOURCE CODE then it should go to Galaxy Tab General as it doesn't belong in Development.
If your thread can be phrased as a question, it DEFINITELY doesn't belong in Development either, post in in the Nexus Q & A section. If you post it in Development it will be moved/closed and you may get an infraction or a ban.
There is only 1 exception, stock ROMs are allowed, as long as the link does not require a registration to download the ROM.
You may start planning a [DEV] topic in the General or Q & A section and then have it moved to the Android Development section once the actual Development has started.
☞ Development is classified as original work and/or documented edits and changes made to others work (with their permission) that makes it your own.
Stock ROM dumps that are modified (deodexed, etc.) from the manufacturer's original intent and then repackaged together classifies as development.
Kernel's and Recovery obviously classify as development as they are modified and compiled from source
☞ Themes are graphical/visual changes made to a ROM which make's the ROM visually different from the original work, i.e. different battery icons, a blue-color scheme, etc. They may be packaged up together with a full ROM and deployed the same way. Simply running a script (not made by you) to deodex and then packaging other people's work/MOD's into one place does not constitute original development.
Follow the FORUM RULES and the XDA MANTRA and we'll all get along and enjoy this community!
Thank you for your cooperation & thanks to jerdog for writing this wonderful explanation.

***** READ Before Posting your Work*****

The following are reasonable formats that are suggested when posting a new ROM. We expect your ROM post to look somewhat professional and easy to understand.
1. Requirements (bootloader version, radio version etc)
2. State that it's from an official manufacturer or source base (stock ROM or AOSP-like source).
3. Thread shows a clear overview of changes made, in a way that users can see what has changed.
4. Explicit installation instructions.
5. ROMs need to identify what kernel they are using. If 100% stock then they must state that.
6. If custom kernel they must provide a link to the kernel on XDA (if available) or a link to the kernel source. This is required by GPL. Stock (untouched) kernels can link to the manufacturers source (if available).
7. At least 2-4 images (screen-shots) 1 of which must be of system/device info. Do not use photo hosts thay deluge users with ads and popups when they select the image. You can either attach the images, or use a hosting service such as photo-bucket for example.
8. Links to downloads. A link to a direct download is preferred. Linking to external websites home pages are not allowed, it must be linked to the Downloads page. Also use of "ad-driven" (adfly for example) or "commercial" sites are mostly not allowed. Registration on some sites "may" be allowed, but is subject to XDA Moderation approval.
9. Credits for sources used. Very important.
10. Keep your "asking for donations to a limit. You already have a "Donate" button.
Simply posting a link to some download site "here it is, download it", is not allowed.
Any questions, please feel free to contact any moderator.
Thank You
Moderation Team

[ROM][KERNEL] MadTwatters AOKP

RULES​1. Read the OP fully.
2. For bug reports, I need a log to assess the issue. Capture a log while replicating the issue.
3. Do not ask ETA's on updates; you will be ignored.
4. Use the "search this thread" feature to make sure your question wasn't already answered by using key words.
5. Only ask a question about this project. Any questions about another ROM or project will be disregarded.
6. If you dont like my ROM then too bad.
7. You want 100% untouched/unmodified AOSP. This isn't the ROM for you.
8. AOKP is open source. so you can always build it yourself.​
Instructions:​Download ROM .zip file
Download KitKat GApps
Download latest SuperSU flashable (Optional)
Reboot to Recovery
Flash ROM, GApps, SuperSU .zip files
Clear Dalvik/Cache
Reboot and Enjoy​If you want to run art thats fine but use at YOUR OWN RISK as i currently do not support it.​
DOWNLOADS
ROM: Mod Edit: Link Removed​GAPPS: HERE​SuperSU: HERE​
Also a quick shoutout to xboxfanj for letting me use his kernel. Thanks bro​
XDA:DevDB Information
One M8, ROM for the HTC One (M8)
Contributors
MadTwatter, xboxfanj
ROM OS Version: 4.4.x KitKat
ROM Kernel: Linux 3.4.x
Based On: AOKP
Version Information
Status: Stable
Current Stable Version: 8.29.2014
Stable Release Date: 2014-08-29
Created 2014-08-31
Last Updated 2014-09-03
Thread closed pending further information and understanding of duplicated thread.
Thread reopened to allow OP to add sources, credits and add more detail regarding the "essence" of this ROM...
It's mostly kernel optimization with a little bit of rom tweaking to make it smoother, when I get time I will sit down and go over the commits that I think are worth telling people about if that makes you feel more comfortable sir.
Sent From The Tardis
MadTwatter said:
It's mostly kernel optimization with a little bit of rom tweaking to make it smoother, when I get time I will sit down and go over the commits that I think are worth telling people about if that makes you feel more comfortable sir.
Sent From The Tardis
Click to expand...
Click to collapse
This thread started out rather poorly and has been cleaned. I'm going to leave the thread open for now so that the OP can update the first post as @LenAsh requested and so that members can help with testing and troubleshooting. I am subscribing to this thread to encourage members to be on their best behavior. Instead of arguing in a thread and posting PMs publicly in a thread, please report the offending posts / PM and let a moderator handle it.
To the OP:
First off, welcome to XDA. We are glad you decided to post a ROM here. A few things:
You are required to post the following. If you do not within the next few days, I will need to close the thread and remove the download links:
1. Kernel source: You mention "kernel optimizations" so you need to upload your source code to Github. If you used a kernel without any changes, then please link to the thread of that kernel.
2. Credits: Link to AOKP at least to give them credit for the base. Also credit for any tweaks you found here that you included.
Suggested things to post. Although these are not required, most threads have them and members expect them so they know what they are flashing (I personally wouldn't flash a ROM without these).:
1. Feature list: what this ROM has that makes it special. You made changes that you liked - what were they?
2. Screenshots
3. Changelog: when you have one since this is the initial release
For more help on what's expected for ROM OPs, please look at these guidelines.
I don't want to close the thread. In fact, I like to encourage people to develop on here. So, please at least post kernel source and credits to keep the thread open. The other stuff is gravy and can be done as you get time or your thread maintainer you mentioned gets to it.
Hope the OP is adjusted according to XDA rules. i'm going to kick things off by flashing and testing this ROM. i'll check for any kind of malware/spyware (crash-test-dummy). Keep your fingers crossed.
Chuckd610 said:
Hope the OP is adjusted according to XDA rules. i'm going to kick things off by flashing and testing this ROM. i'll check for any kind of malware/spyware (crash-test-dummy). Keep your fingers crossed.
Click to expand...
Click to collapse
I wouldn't be holding my breath on the OP providing the info requested by @coal686. I see he's been active around the place, but this mustn't be a priority.
Out of interest, did you flash the ROM, and if you did, how did it go?
OP has stated that he is not going to update the thread to give credits (kernel source is in the download tab), so thread closed and download link removed until he changes his mind.

Categories

Resources