diff --git a/car_srv/clients/flash/README.md b/car_srv/clients/flash/README.md new file mode 100644 index 00000000000..3183e5820aa --- /dev/null +++ b/car_srv/clients/flash/README.md @@ -0,0 +1,17 @@ +# Firmware client + +## Building + +move to this directory + + $ ./gradlew build + +This command build all project. Executable .jar file placed on ./build/libs + +## Run client + +for run client you can use script + + $ ./run.sh + +run script without params or with --help to see available options diff --git a/car_srv/clients/rc/README.md b/car_srv/clients/rc/README.md new file mode 100644 index 00000000000..e286cbb89cf --- /dev/null +++ b/car_srv/clients/rc/README.md @@ -0,0 +1,17 @@ +# Remote control client + +## Building + +move to this directory + + $ ./gradlew build + +This command build all project. Executable .jar file placed on ./build/libs + +## Run client + +for run client you can use script + + $ ./run.sh + +run script without params or with --help to see available options diff --git a/car_srv/kotlinSrv/README.md b/car_srv/kotlinSrv/README.md new file mode 100644 index 00000000000..b21f14c64da --- /dev/null +++ b/car_srv/kotlinSrv/README.md @@ -0,0 +1,33 @@ +# Car server + +## Building + +move to this directory + + $ ./build.sh + +This command run gradle build and execute *npm install* for downloading used js modules. + +## Run car server + +for run server you can use script + + $ ./run.sh + +## Deploying car server + +*note:* This feature is under development + +*note:* this script use expect script languane. You have to install it + +for install expect on ubuntu + + $ sudo apt-get install expect + +for deploy server on car use + + $ ./deploy.sh -h {ip_addr} -u {user_name} -p {password} + +where: +{ip_addr} - ip address of raspberry. +{user_name} and {password} - user name and password for login on raspberry diff --git a/server/README.md b/server/README.md new file mode 100644 index 00000000000..a7f81bca8bf --- /dev/null +++ b/server/README.md @@ -0,0 +1,17 @@ +# Main server + +## Building + +move to this directory + + $ ./gradlew build + +This command build all project. Executable .jar file placed on ./build/libs + +## Run server + +for run server you can use script + + $ ./run.sh + +after start you will see available commands. You can input their from command line