X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=92be1c88b70152cd79065e4967d8f4533400ad0d;hb=a2df8ec64eef1acd699633e42806e75dc7a7ee55;hp=16d09466ed80fb75d53e37725a05c7b38c2498c2;hpb=1122b6ed058435e3ea32b39511fbc1ee251fee1b;p=src%2Fxds%2Fxds-server.git diff --git a/README.md b/README.md index 16d0946..92be1c8 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,11 @@ Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Make make all ``` +And to install xds-server in /usr/local/bin: +```bash +make install +``` + ## How to run ## Configuration @@ -69,11 +74,14 @@ Supported fields in configuration file are: ## Start-up +Use `xds-start-server.sh` script to start all requested tools ```bash -./bin/xds-server -c config.json +/usr/local/bin/xds-start-server.sh ``` -**TODO**: add notes about Syncthing setup and startup +>**NOTE** you can define some environment variables to setup for example +config file `XDS_CONFFILE` or change logs directory `LOGDIR`. +See head section of `xds-start-server.sh` file to see all configurable variables. ## Debugging @@ -99,6 +107,8 @@ The server part is written in *Go* and web app / dashboard (client part) in | +-- README.md this readme | ++-- scripts/ hold various scripts used for installation or startup +| +-- tools/ temporary directory to hold development tools (like glide) | +-- vendor/ temporary directory to hold Go dependencies packages