summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8bbdf39..95f4f1f 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,17 @@ Until the package is uploaded onto PyPI, either:
or
* `pip install` the generated zip from the repository(when public)
+
+or
+
+* git clone \<repo\>
+* mkdir packages && cd packages
+* pip wheel ../\<repo\>
+
+which creates "wheels" for pyagl and the dependencies it needs
+\- specified in setup.py - and are pip installable
+
+
---
## Creating new modules
Creating a new modules and tests can be done with a few steps:
@@ -64,7 +75,7 @@ pytest
Running the tests rests on the assumptions that the following environment variables will be exported:
All tests require AGL_TGT_IP and will look for AGL_TGT_PORT
-* AGL_TGT_IP - required - the containing the IP Address for the AGL instance
+* AGL_TGT_IP - required - pointing at an IP Address with AGL instance
* AGL_TGT_PORT - optional - if not exported, the library wil connect to the IP address via ssh to find out the service's listening TCP port
* AGL_BTMAP_RECIPIENT - optional - When running Bluetooth MAP tests, this would be used as phone number to write text messages to
* AGL_BTMAP_TEXT - optional - When running Bluetooth MAP tests, messages will be composed with this text