virtual-usb-printer: Updating README
BUG=None
TEST=None
Change-Id: I208ce885040a86ccf6a3f90c18e5531f04fad98f
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/third_party/virtual-usb-printer/+/1759133
Commit-Queue: David Valleau <valleau@chromium.org>
Tested-by: David Valleau <valleau@chromium.org>
Reviewed-by: Sean Kau <skau@chromium.org>
diff --git a/README.md b/README.md
index 289636e..7d7b8d7 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,6 @@
+ USBIP kernel modules:
+ CONFIG\_USBIP\_CORE
+ CONFIG\_USBIP\_VHCI\_HCD
-+ Linux Kernel v4.14 - USBIP currently only works on this kernel version
In order to actually "connect" the virtual printer to the system the USBIP
program is used.
@@ -29,6 +28,19 @@
For the purposes of the virtual printer, only the client portion of USBIP is
required so that the virtual device can be bound to the system.
+## Installation
+
+Currently the USBIP program is only installed by default for the elm and betty
+boards.
+
+In order to install it on your test image, you need to build an image with the
+`usbip` USE flag enabled. To do this, all you need to to is run `build_packages`
+with the USE flag enabled.
+
+```
+USE="usbip" ./build_packages --board=$BOARD
+```
+
## How to Use
Run the virtual-usb-printer program:
@@ -79,3 +91,15 @@
+ Only needed for IPP-over-USB printer configurations
+ `--record_doc_path` - full path to the file used to record documents received
from print jobs
+
+## Using in Tast
+
+There are currently existing tast tests which leverage virtual-usb-printer in order to test native printing. The following can be used as examples in order to write new tests:
+
++ [Add USB Printer](https://cs.corp.google.com/chromeos_public/src/platform/tast-tests/src/chromiumos/tast/local/bundles/cros/printer/add_usb_printer.go)
+ + Tests that adding a basic USB printer works correctly
++ [Print USB](https://cs.corp.google.com/chromeos_public/src/platform/tast-tests/src/chromiumos/tast/local/bundles/cros/printer/add_usb_printer.go)
+ + Tests that the full print pipeline works correctly for a basic USB printer
++ [Print IPPUSB](https://cs.corp.google.com/chromeos_public/src/platform/tast-tests/src/chromiumos/tast/local/bundles/cros/printer/print_ippusb.go)
+ + Tests that the full print pipeline for IPP-over-USB printing works correctly
+ + This also tests that the [automatic_usb_printer_configurer](https://codesearch.chromium.org/chromium/src/chrome/browser/chromeos/printing/automatic_usb_printer_configurer.h) is able to automatically configure an IPP everywhere printer
