Clean up README

Change-Id: I23e9c0e7095aadaa597fd9311671c434c1be697a
This commit is contained in:
Clark Scheff 2014-09-12 10:04:25 -07:00
parent 9a94bc262b
commit 5b783313d1
1 changed files with 9 additions and 10 deletions

View File

@ -89,16 +89,15 @@ assets/<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;├──colors.xml<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;└──styles.xml<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;├──ringtones/<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;└──foo.{ mp3, ogg, wav, ... }<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;└──foo.{ mp3, ogg }<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;└──wallpapers/<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;└──foo.{ jpg, png, ... }<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;└──foo.{ jpg, png }<br>
<br>
| Directory | Description |
| -----------|------------- |
| **alarms/** <br> **ringtones/** <br> **notifications/** | Each of these directories should contain a single audio file to be set as the respective system sound. |
| **lockscreen/** <br> **wallpapers/** | Each of these directories should contain a single image file to be used as the respective wallpaper (lockscreen or home screen). Support for providing multiple wallpaper options in a single theme may be implemented in the future. |
| **bootanimation/** | This directory should contain a single, standard format multi-part boot animation zip file. For help creating boot animations, visit this thread on XDA: http://forum.xda-developers.com/showthread.php?t=1852621 |
| **images/** | This directory should contain three images, to be displayed in the Theme Chooser: <br><br>All 3 images must be 600px wide by 1080px tall.<br><br>`lockscreen_preview.jpg` must be a cropped version of your lockscreen wallpaper.<br><br>`wallpaper_preview.jpg` must be a cropped version of your home screen wallpaper.<br><br>`style_preview.jpg` must be a screenshot displaying an actual example of your theme's overlay style in-use. |
| **icons/** | This directory uses the de-facto standard format for icon theming that's been in use for some time among Launchers. Icons are placed in DPI-named directories and are then referenced in `xml/appfilters.xml`.<br><br>Dont forget to put everything inside `icons/res/`<br><br>To learn more about how to set up the file structure for icons and how to theme icons in Android, see the **ICONS** section of this thread on XDA: http://forum.xda-developers.com/showthread.php?t=1649891 |
| **overlays/** | Contains drawables and values for each package or system component to be themed. Drawables and components within XMLs are a 1-to-1 replacement for elements defined in installed packages.<br><br>Additionally contains a `common/` directory which is used to define assets that can be reused across multiple applications. To reference an item from `common/`, preface an element's `src=` with `@*common:` |
**Directory** : *Description*<br><br>
**alarms**:<br> **ringtones**:<br> **notifications**: Each of these directories should contain a single audio file to be set as the respective system sound.<br><br>
**lockscreen**:<br> **wallpapers**: Each of these directories should contain a single image file to be used as the respective wallpaper (lockscreen or home screen). Support for providing multiple wallpaper options in a single theme may be implemented in the future.<br><br>
**bootanimation**: This directory should contain a single, standard format multi-part boot animation zip file. For help creating boot animations, visit this thread on XDA: http://forum.xda-developers.com/showthread.php?t=1852621<br><br>
**images**: This directory should contain three images, to be displayed in the Theme Chooser: <br><br>All 3 images must be 600px wide by 1080px tall.<br><br>`lockscreen_preview.jpg` must be a cropped version of your lockscreen wallpaper.<br><br>`wallpaper_preview.jpg` must be a cropped version of your home screen wallpaper.<br><br>`style_preview.jpg` must be a screenshot displaying an actual example of your theme's overlay style in-use.<br><br>
**icons**: This directory uses the de-facto standard format for icon theming that's been in use for some time among Launchers. Icons are placed in DPI-named directories and are then referenced in `xml/appfilters.xml`.<br><br>Dont forget to put everything inside `icons/res/`<br><br>To learn more about how to set up the file structure for icons and how to theme icons in Android, see the **ICONS** section of [this thread on XDA](http://forum.xda-developers.com/showthread.php?t=1649891)<br><br>
**overlays**: Contains drawables and values for each package or system component to be themed. Drawables and components within XMLs are a 1-to-1 replacement for elements defined in installed packages.<br>Additionally contains a `common/` directory which is used to define assets that can be reused across multiple applications. To reference an item from `common/`, preface an element's `src=` with `@*common:`