瀏覽代碼

Add environment setup section and fix script path (#463)

Ludovic BOUÉ 3 天之前
父節點
當前提交
8c607441b7
共有 1 個文件被更改,包括 9 次插入1 次删除
  1. 9 1
      README.md

+ 9 - 1
README.md

@@ -2,6 +2,14 @@
 
 Library to control Switchbot IoT devices https://www.switch-bot.com/
 
+## Setting up the environment
+
+```shell
+python3 -m venv .venv
+source .venv/bin/activate
+pip install .
+```
+
 ## Obtaining encryption key for Switchbot Locks
 
 Using the script `scripts/get_encryption_key.py` you can manually obtain locks encryption key.
@@ -9,7 +17,7 @@ Using the script `scripts/get_encryption_key.py` you can manually obtain locks e
 Usage:
 
 ```shell
-$ python3 get_encryption_key.py MAC USERNAME
+$ python3 scripts/get_encryption_key.py MAC USERNAME
 Key ID: XX
 Encryption key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 ```