From f2c1c7fc707f068b9633f1dda81e1a6c8151a86e Mon Sep 17 00:00:00 2001 From: Sander Koenders Date: Thu, 12 Oct 2017 08:02:34 +0200 Subject: [PATCH] Docs: Use a table for available switches Overall this looks cleaner to me, feel free to revert if you feel like it's not. --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f95701f..a0fd942 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,17 @@ cd docker-lineageos 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) -* -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) +| Switch | Alternative | Description | +|---|---|---| +| `-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]. +### 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 ``` @@ -40,9 +45,6 @@ breakfast # example: breakfast grouper brunch # 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 For further information, check the following links: