Browse Source

Added a description of dependencies and usage

Clara Hobbs 7 years ago
parent
commit
1c685c480b
1 changed files with 29 additions and 2 deletions
  1. 29
    2
      README.md

+ 29
- 2
README.md View File

@@ -1,3 +1,30 @@
1
-# pd-buddy-gtk
1
+# PD Buddy Configuration
2 2
 
3
-GTK+ GUI for PD Buddy Sink configuration
3
+PD Buddy Configuration is a GTK+ GUI for configuring PD Buddy Sink devices.
4
+
5
+## Dependencies
6
+
7
+PD Buddy Configuration is developed with these versions of its dependencies,
8
+but older versions may work.
9
+
10
+* GTK+ 3.22
11
+* Python 3.6
12
+* python-gobject 3.22
13
+* pyserial 3.2
14
+
15
+## Usage
16
+
17
+Plug your PD Buddy Sink(s) into your computer while holding the Setup button.
18
+Start PD Buddy Configuration with:
19
+
20
+    $ ./pd-buddy-gtk.py
21
+
22
+You will be greeted with a list of connected PD Buddy devices.  If there is
23
+more than one connected, you can identify them by clicking the light bulb
24
+button in each list entry (the selected device's LED will blink rapidly for two
25
+seconds).
26
+
27
+Click one of the list items to configure the device.  Select the desired
28
+voltage and current, then click Save.  If you want to configure other devices,
29
+click the Back arrow to return to the list.  After the settings have been
30
+saved, the devices can be safely disconnected at any time.

Loading…
Cancel
Save