From ca442f74f92511fc3ad9390931ae79cfbb02f289 Mon Sep 17 00:00:00 2001
From: Daniele Procida <daniele@vurt.org>
Date: Sat, 4 Jan 2020 14:34:45 +0000
Subject: [PATCH] Added get-started steps

---
 README.md | 42 ++++++++++++++++++++++++++++++++++--------
 1 file changed, 34 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index b48ac9a..9e06a39 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,45 @@
 # MusicCastControl
 MQTT interface for Yamaha MusicCast
 
-Receives events from the MusicCast device when a value changes and publishes them to MQTT. 
+Receives events from the MusicCast device when a value changes and publishes them to MQTT.
 
-Publishes topics in the format: 
+
+## Get started
+
+Clone the repository:
+
+```
+git clone git@github.com:Iture/MusicCastControl.git
+```
+
+Create and activate a virtual environment:
+
+```
+cd MusicCastControl
+python3 -m venv env
+source env/bin/activate
+```
+
+Edit the `config.json` file according to your own requirements, paying attention to:
+
+* `"mqtt_host"`
+* `"mc_devices"`
+
+Run:
+
+```
+python3 MusicCastController.py
+```
+
+## Technical reference
+
+Publishes topics in the format:
 
 MusicCast/friendly_name/power
 
-To set a value, use: 
+To set a value, use:
 
-MusicCast/friendly_name/power/set 
+MusicCast/friendly_name/power/set
 
 Example values from a Yamaha A2060 (Zone 3 with a friendly_name of dining_room):
 
@@ -27,7 +57,3 @@ MusicCast/dining_room/disable_flags:0
 ```
 
 friendly_names, ip addresses and zones are defined in config.json
-
-To start run: 
-
-python3 MusicCastController.py