1
0
mirror of https://github.com/stucki/docker-lineageos synced 2024-12-19 17:12:29 -05:00

Docs: Use a table for available switches

Overall this looks cleaner to me, feel free to revert if you feel like it's not.
This commit is contained in:
Sander Koenders 2017-10-12 08:02:34 +02:00 committed by Michael Stucki
parent 07ef214d52
commit f2c1c7fc70

View File

@ -24,12 +24,17 @@ cd docker-lineageos
The `run.sh` script accepts the following switches: The `run.sh` script accepts the following switches:
* -u|--enable-usb - runs the container in privileged mode (this way you can use adb right from the container) | Switch | Alternative | Description |
* -r|--rebuild - force rebuild the image from scratch |---|---|---|
* -ws|--with-su - Sets the WITH_SU environment variable to true (your builds will include the su binary) | `-u` | `--enable-usb` | Runs the container in privileged mode (this way you can use adb right from the container) |
| `-r` | `--rebuild` | Force rebuild the image from scratch |
| `-ws` | `--with-su` | Sets the WITH_SU environment variable to true (your builds will include the su binary) |
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]. 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].
### ADB in the container
If you're on Linux and want to use adb from within the container running with `-u` might not be enough. Make sure you have the [Android udev rules](https://github.com/M0Rf30/android-udev-rules/blob/master/51-android.rules) installed on your host system so you can access your device without needing superuser permissions.
### How to build LineageOS for your device ### How to build LineageOS for your device
``` ```
@ -40,9 +45,6 @@ breakfast <device codename> # example: breakfast grouper
brunch <device codename> # example: brunch grouper brunch <device codename> # example: brunch grouper
``` ```
### ADB in the container
If you're on Linux and want to use adb from within the container running with `-u` might not be enough. Make sure you have the [Android udev rules](https://github.com/M0Rf30/android-udev-rules/blob/master/51-android.rules) installed on your host system so you can access your device without needing superuser permissions.
### Links ### Links
For further information, check the following links: For further information, check the following links: