diff --git a/cmd/berryMSE/README.md b/cmd/berryMSE/README.md index 5cf3cbd..7c76b94 100644 --- a/cmd/berryMSE/README.md +++ b/cmd/berryMSE/README.md @@ -1,9 +1,11 @@ # BerryMSE Demo -This is a demo application that can build and run without many preparation. The release download contains this executable for the Raspberry Pi with armv7l architecture. +This is a demo application that can be built or run by downloading the executable form the release page. The release download contains the executable for the Raspberry Pi with armv7l architecture. ## Build +In order to build this application your self please follow the steps below: + To fetch dependencies: Linux: @@ -18,7 +20,7 @@ Windows: go get -v ./... go install github.com/markbates/pkger/cmd/pkger -To build: +To build execute make in the `cmd/berryMSE` folder: make @@ -27,16 +29,16 @@ or: make armv6l make armv7l -A folder will be created that contains the executable +A folder will be created that contains the executable. ## Usage -To run, copy the appropriate `berrymse` executable to the Raspberry Pi and perform ``chmod +x berrymse``. Now you can run it with: +To run, copy the appropriate `berrymse` executable to the Raspberry Pi and perform ``chmod +x berrymse``, to make it executable. Now you can run it with: ./berrymse -l :2020 -d /dev/video For example: - ./berrymse -l 192.168.2.1:2020 -d /dev/video0 + ./berrymse -l 0.0.0.0:2020 -d /dev/video0 A more detailed usage instruction can be found in the [README_Executable](README_Executable.md). \ No newline at end of file