docker-lineageos/README.md

docker-cyanogenmod
==================

Create a [Docker] based environment to build [CyanogenMod].

This Dockerfile will create a docker container which is based on Ubuntu 12.04.
It will install the "repo" utility and any other build dependencies which are required to compile CyanogenMod.

The main working directory is a shared folder on the host system, so the Docker container can be removed at any time.

**NOTE:** Remember that CyanogenMod is a huge project. It will consume a large amount of disk space (~80 GB) and it can easily take hours to build.

### How to run/build

**NOTES:**
* You will need to [install Docker][Docker_Installation] to proceed!
* If an image does not exist, ```docker build``` is executed first
* When running ```docker build```, the whole folder incl. the "android" working directory is transferred to the Docker daemon. The only way to work around this currently is to move the "android" folder away, then rebuild, and move it back into place again.
For more information, see [dotcloud/docker#2224].

```
git clone https://github.com/stucki/docker-cyanogenmod.git
cd docker-cyanogenmod
./run.sh
```

The container uses "screen" to run the shell. This means that you will be able to open additional shells using [screen keyboard shortcuts][Screen_Shortcuts].

### How to build CyanogenMod for your device

```
repo init -u git://github.com/CyanogenMod/android.git -b cm-11.0
repo sync
vendor/cm/get-prebuilts
source build/envsetup.sh
breakfast <device codename>   # example: breakfast grouper
brunch <device codename>      # example: brunch grouper
```

### Links

For further information, check the following links:

* [CyanogenMod Building Basics][Cyanogenmod_Building_Basics]
* [Learning to Build CyanogenMod][Learning_to_Build_CM]
* [Build Instructions for Google Nexus 5][CyanogenMod_Build_Nexus5] (example device, search the wiki for other devices)

### More information

* [Discussion thread @ XDA developers]

==================

[Docker]:                      https://www.docker.io/
[CyanogenMod]:                 http://www.cyanogenmod.org/
[Docker_Installation]:         https://www.docker.io/gettingstarted/
[Screen_Shortcuts]:            http://www.pixelbeat.org/lkdb/screen.html
[CyanogenMod_Building_Basics]: http://wiki.cyanogenmod.org/w/Doc:_Building_Basics
[Learning_to_Build_CM]:        http://wiki.cyanogenmod.org/w/Development#Learning_To_Build_CM
[CyanogenMod_Build_Nexus5]:    http://wiki.cyanogenmod.org/w/Build_for_hammerhead
[Discussion thread @ XDA developers]: http://forum.xda-developers.com/showthread.php?t=2650345
[dotcloud/docker#2224]:        https://github.com/dotcloud/docker/issues/2224
Add README.md 2014-02-16 07:30:32 -05:00			`docker-cyanogenmod`
			`==================`

			`Create a [Docker] based environment to build [CyanogenMod].`

			`This Dockerfile will create a docker container which is based on Ubuntu 12.04.`
			`It will install the "repo" utility and any other build dependencies which are required to compile CyanogenMod.`

[TASK] Fix typo in README.md 2014-07-18 14:24:20 -04:00			`The main working directory is a shared folder on the host system, so the Docker container can be removed at any time.`
Add README.md 2014-02-16 07:30:32 -05:00
			`NOTE: Remember that CyanogenMod is a huge project. It will consume a large amount of disk space (~80 GB) and it can easily take hours to build.`

refactor(run.sh): Combined run and build scripts fix(Dockerfile): Removed unnecessary PPA fix(Dockerfile): Removed duplicate curl package chore(Readme.md): Update documentation 2014-07-14 01:30:56 -04:00			`### How to run/build`
Add README.md 2014-02-16 07:30:32 -05:00
Add note on dotcloud/docker#2224 2014-02-20 11:09:33 -05:00			`NOTES:`
			`* You will need to [install Docker][Docker_Installation] to proceed!`
Fix some typos 2014-07-18 17:48:18 -04:00			* If an image does not exist, ```docker build``` is executed first
Add note on dotcloud/docker#2224 2014-02-20 11:09:33 -05:00			* When running ```docker build```, the whole folder incl. the "android" working directory is transferred to the Docker daemon. The only way to work around this currently is to move the "android" folder away, then rebuild, and move it back into place again.
			`For more information, see [dotcloud/docker#2224].`
Add a note that Docker is required for this. No Docker, no fun. 2014-02-18 08:05:05 -05:00
Add README.md 2014-02-16 07:30:32 -05:00			```
			`git clone https://github.com/stucki/docker-cyanogenmod.git`
			`cd docker-cyanogenmod`
			`./run.sh`
			```

			`The container uses "screen" to run the shell. This means that you will be able to open additional shells using [screen keyboard shortcuts][Screen_Shortcuts].`

			`### How to build CyanogenMod for your device`

			```
			`repo init -u git://github.com/CyanogenMod/android.git -b cm-11.0`
			`repo sync`
Add note about running get-prebuilts 2014-02-20 02:52:33 -05:00			`vendor/cm/get-prebuilts`
Add README.md 2014-02-16 07:30:32 -05:00			`source build/envsetup.sh`
			`breakfast <device codename> # example: breakfast grouper`
			`brunch <device codename> # example: brunch grouper`
			```

			`### Links`

			`For further information, check the following links:`

			`* [CyanogenMod Building Basics][Cyanogenmod_Building_Basics]`
			`* [Learning to Build CyanogenMod][Learning_to_Build_CM]`
			`* [Build Instructions for Google Nexus 5][CyanogenMod_Build_Nexus5] (example device, search the wiki for other devices)`

Add link to discussion thread at XDA 2014-02-16 08:44:45 -05:00			`### More information`

			`* [Discussion thread @ XDA developers]`

Add README.md 2014-02-16 07:30:32 -05:00			`==================`

			`[Docker]: https://www.docker.io/`
			`[CyanogenMod]: http://www.cyanogenmod.org/`
Add a note that Docker is required for this. No Docker, no fun. 2014-02-18 08:05:05 -05:00			`[Docker_Installation]: https://www.docker.io/gettingstarted/`
Add README.md 2014-02-16 07:30:32 -05:00			`[Screen_Shortcuts]: http://www.pixelbeat.org/lkdb/screen.html`
			`[CyanogenMod_Building_Basics]: http://wiki.cyanogenmod.org/w/Doc:_Building_Basics`
			`[Learning_to_Build_CM]: http://wiki.cyanogenmod.org/w/Development#Learning_To_Build_CM`
			`[CyanogenMod_Build_Nexus5]: http://wiki.cyanogenmod.org/w/Build_for_hammerhead`
Add link to discussion thread at XDA 2014-02-16 08:44:45 -05:00			`[Discussion thread @ XDA developers]: http://forum.xda-developers.com/showthread.php?t=2650345`
Add note on dotcloud/docker#2224 2014-02-20 11:09:33 -05:00			`[dotcloud/docker#2224]: https://github.com/dotcloud/docker/issues/2224`