README template replaced
authorebelcrom <ebelcrom@gmail.com>
Sun, 28 Jan 2018 22:39:42 +0000 (23:39 +0100)
committerebelcrom <ebelcrom@gmail.com>
Sun, 28 Jan 2018 22:39:42 +0000 (23:39 +0100)
README.md

index f4a7ad8048bc1b5095d004976f9c76aea1a50698..262a9d8136b2e79417383f3066bee63611dbc214 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,29 @@
-# IPRemoteSwitch.git
+# IPRemoteSwitch
 
-description....
+IPRemoteSwitch is an Android app that is able to switch on/off a remote PC. The
+remote local network should have a RPi running sshd. The PRi switches the PC
+using a relais wired over ATX with the power button of the remote machine. Ping
+is using for monitoring the state of the PC.
 
 ## Getting started
 
-These instructions will get you a copy of the project up and running on your local
-machine.
+These instructions will get you a copy of the project up and running on your
+devices
 
 ### Installing
 
-installing instuctions...
+Get the project using git:
+
+```
+git clone https://binomiant.duckdns.org/MpqU9XX8/IPRemoteSwitch.git
+```
+
+Copy the shell script from external/ to your RPi and make it executable:
+
+```
+scp external/switch.sh pi@mymachine:/home/pi/
+chmod 755 switch.sh
+```
+
+Load this project to Android Studio or Eclipse with ADT plugin, build and deloy
+it to your mobile device and start it.