From 90a7638c4d05069f2d0a4721e94709fcb7feec01 Mon Sep 17 00:00:00 2001 From: Nikos Ftylitakis Date: Mon, 23 Mar 2020 21:34:54 +0200 Subject: [PATCH] Update README file Added info for 'verbose' flag and updated the list of supported commands. --- README.md | 40 ++++++++++++++++++++++++++++------------ 1 file changed, 28 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 8826241..4ddc165 100644 --- a/README.md +++ b/README.md @@ -42,23 +42,39 @@ You should see usage information displayed like below: Usage: ampy [OPTIONS] COMMAND [ARGS]... ampy - Adafruit MicroPython Tool - + Ampy is a tool to control MicroPython boards over a serial connection. Using ampy you can manipulate files on the board's internal filesystem and even run scripts. - + Options: - -p, --port PORT Name of serial port for connected board. [required] - -b, --baud BAUD Baud rate for the serial connection. (default 115200) - -d, --delay DELAY Delay in seconds before entering RAW MODE (default 0) - --help Show this message and exit. - + -p, --port PORT Name of serial port for connected board. Can optionally + specify with AMPY_PORT environment variable. [required] + + -b, --baud BAUD Baud rate for the serial connection (default 115200). + Can optionally specify with AMPY_BAUD environment + variable. + + -d, --delay DELAY Delay in seconds before entering RAW MODE (default 0). + Can optionally specify with AMPY_DELAY environment + variable. + + -v, --verbose Print messages to monitor the progress of the requested + operation. + + --version Show the version and exit. + --help Show this message and exit. + Commands: - get Retrieve a file from the board. - ls List contents of a directory on the board. - put Put a file on the board. - rm Remove a file from the board. - run Run a script and print its output. + get Retrieve a file from the board. + ls List contents of a directory on the board. + mkdir Create a directory on the board. + put Put a file or folder and its contents on the board. + reset Perform soft reset/reboot of the board. + rm Remove a file from the board. + rmdir Forcefully remove a folder and all its children from the board. + run Run a script and print its output. + If you'd like to install from the Github source then use the standard Python setup.py install (or develop mode):