diff --git a/README.md b/README.md index bc26d59d843c7ce6107ab91db0e4edba2b23deb1..fd8a6b112c295fba3852db129419478d33bcebe6 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,36 @@ Configure workspace 2. Navigate under `$GOPATH/src` and clone this repository -3. At this point, you will be able to install the DFSS project with a simple command, anywhere from your computer: +3. Install build dependencies in `dfss/` directory ```bash -go install dfss/... +dfss/build/deps.sh +``` + +4. At this point, you will be able to install the DFSS project with some simple commands + +- To install CLI applications: + +```bash +go install dfss/dfssc # Client +go install dfss/dfssp # Platform +go install dfss/dfsst # TTP + +# or + +make install +``` + +- To build GUI for client into `bin/` directory (using docker image) + +``` +# You may have to run these commands as root due to docker (sudo won't work) + +# Prepare docker image, one time only +make prepare_gui + +# Build +make gui ``` Run dfss modules @@ -23,6 +49,6 @@ Run dfss modules ```bash dfssc help # Client -dfssp help # Plaform -dfssd help # Demonstrator +dfssp help # Platform +dfsst help # TTP ```