| Skyler Kaufman | 991ae4d | 2011-04-07 12:30:41 -0700 | [diff] [blame^] | 1 | # HOW TO BUILD SOURCE.ANDROID.COM # |
| 2 | |
| 3 | source.android.com contains tutorials, references, and miscellaneous information relating to the Android Open Source Project (AOSP). The current iteration of this site is fully static HTML (notably lacking in javascript and doxygen content), and is and/or was maintained by skyler (illustrious intern to the almighty JBQ). |
| 4 | |
| 5 | ## Short Instructions ## |
| 6 | |
| 7 | Run the build script. |
| 8 | |
| 9 | build.py |
| 10 | |
| 11 | This generates a directory html_out, which is the fully built site. Hoorah. |
| 12 | |
| 13 | |
| 14 | ## Less Short Instructions ## |
| 15 | |
| 16 | ### Contents Included in Box ### |
| 17 | |
| 18 | Necessary source files include: |
| 19 | |
| 20 | site_src/ individual page content in markdown format |
| 21 | templates/ templates for page content |
| 22 | |
| 23 | and the following content which is copied directly: |
| 24 | |
| 25 | assets/ stylish things that make the page look pretty |
| 26 | images/ exactly what it sounds like |
| 27 | cdds/ compatibility documents in PDF format |
| 28 | |
| 29 | |
| 30 | ### Structure of Site Source ### |
| 31 | |
| 32 | The build script currently assumes that |
| 33 | - directory structure in site_src is only one level deep; |
| 34 | - every file under the site_src directory is an individual page of source.android.com; |
| 35 | - each directory within site_src is a tab of source.android.com and contains its particular sidebar. |
| 36 | |
| 37 | These assumptions are kind of stupid, but for the moment, they work, because source.android.com is actually very simple. |
| 38 | |
| 39 | |
| 40 | |
| 41 | # SORDID HISTORY OF SOURCE.ANDROID.COM # |
| 42 | |
| 43 | |