diff --git a/README.md b/README.md index 9c5299b..33cd376 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ +##VMX: The vision.ai object detection/recognition server + + VMX makes computer vision easy. Docker makes bundling complex + applications easy. The vmx-docker-manager lets you run the VMX + Object Detection server on a Linux computer, or a (Mac/Windows) + machine via boot2docker. [We also provide a non-docker native Mac + OS X build of VMX]. + ##Requirements - 64 bit linux and docker >= 1.2 + 64 bit Linux and Docker >= 1.2 + boot2docker for Mac or Windows ##Instructions diff --git a/vmx b/vmx index eff0402..eedda9a 100755 --- a/vmx +++ b/vmx @@ -1,5 +1,12 @@ #!/bin/sh - +# VMX Docker Manager by vision.ai +# Starts the vision.ai object recognition server +# Requires docker >= 1.2; and perms to run docker +# Visit us on the web: +# https://vision.ai +# Github repository for this file: +# https://github.com/VISIONAI/vmx-docker-manager +# ##PARAMS cmd=$1 config=$2 @@ -23,6 +30,7 @@ init () { usage () { echo "VMX Docker Manager by vision.ai" + echo "Version: " `git describe --tags --dirty 2>/dev/null || echo no-git` echo "Requires docker >= 1.2; and perms to run docker" echo "===============================================" echo "Usage: vmx COMMAND [OPTIONS]" @@ -54,6 +62,10 @@ usage () { echo " $ ./vmx update latest" echo " - Update vmx to dev version" echo " $ ./vmx update dev" + echo " " + echo " - Update the vmx-docker-manager" + echo " $ git pull" + exit 1 } @@ -238,6 +250,7 @@ update_vmx(){ if [ "$A$B$C" = "000" ]; then echo "Successfully updated, you can now restart vmx" + echo "To update the vmx-docker-manager, run: git pull" else echo "Problem updating vmx" fi