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 will 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 build

**NOTE:** You will need to [install Docker][Docker_Installation] to proceed!

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

### How to run

```
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
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
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.`

			`The main working directory is a shared folder on the host system, so the Docker container will 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 build`

Add a note that Docker is required for this. No Docker, no fun. 2014-02-18 08:05:05 -05:00			`NOTE: You will need to [install Docker][Docker_Installation] to proceed!`

Add README.md 2014-02-16 07:30:32 -05:00			```
			`git clone https://github.com/stucki/docker-cyanogenmod.git`
			`cd docker-cyanogenmod`
			`./build.sh`
			```

			`### How to run`

			```
			`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`
			`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`