X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=README.md;h=b910e06fe36770d26ceb40777bb1beab026f0392;hb=51da3506a296b7d5d4185b17364f188292136888;hp=2f068cf01a4cdf300e03cc8975879ed4a095fddc;hpb=9c87f58ae1bc719f17fb690e7cb886c1a60d7d3b;p=src%2Fxds%2Fxds-server.git diff --git a/README.md b/README.md index 2f068cf..b910e06 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# XDS - X(cross) Development System +# XDS - X(cross) Development System Server XDS-server is a web server that allows user to remotely cross build applications. @@ -56,16 +56,21 @@ xds-server configuration is driven by a JSON config file (`config.json`). Here is the logic to determine which `config.json` file will be used: 1. from command line option: `--config myConfig.json` 2. `$HOME/.xds/config.json` file -3. `/config.json` file +3. `/config.json` file +4. `/config.json` file Supported fields in configuration file are: ```json { "webAppDir": "location of client dashboard (default: webapp/dist)", "shareRootDir": "root directory where projects will be copied", + "logsDir": "directory to store logs (eg. syncthing output)", + "sdkRootDir": "root directory where cross SDKs are installed", "syncthing": { + "binDir": "syncthing binaries directory (default: executable directory)", "home": "syncthing home directory (usually .../syncthing-config)", - "gui-address": "syncthing gui url (default http://localhost:8384)" + "gui-address": "syncthing gui url (default http://localhost:8384)", + "gui-apikey": "syncthing api-key to use (default auto-generated)" } } ``` @@ -107,6 +112,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