Skip to content

Commit

Permalink
#3 readme better formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Jack Davis committed Jan 25, 2020
1 parent b1caff5 commit 99392e3
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,27 +21,34 @@ First, build the static [HIDAPI](https://github.com/mstrthealias/HIDAPI-Qt5) lib

Note: HIDAPI should be cloned into this project's parent directory (or clone the [parent project](https://github.com/mstrthealias/TeensyFanController/) with all submodules).

1. Launch `x64 Native Tools Command Prompt for VS 2017`
1. Launch **x64 Native Tools Command Prompt for VS 2017**
1. Add Qt5 to PATH, fe.:

```
SET PATH=%PATH%;c:\share\Qt\5.13.2\msvc2017_64\bin
```

1. Change directory to HIDAPI
1. Run qmake:

```
qmake
```

1. Run nmake:

```
nmake
```

1. Verify HIDAPI.lib was created:

```
dir windows\HIDAPI.lib
...
12/30/2019 11:03 AM 27,960 HIDAPI.lib

```

Building the Fan Controller UI:

Expand All @@ -57,7 +64,7 @@ Prerequisites:
1. Qt Installer
1. Recent Qt release (Qt 5.13.2 at time of writing) for GCC 64-bit
1. Qt Charts component
1. apt install build-essential libxkbcommon-x11-0 libhidapi-dev libhidapi-hidraw0 libgl1 libgl1-mesa-dev libx11-xcb1
1. `apt install build-essential libxkbcommon-x11-0 libhidapi-dev libhidapi-hidraw0 libgl1 libgl1-mesa-dev libx11-xcb1`


Note: I experienced issues launching the application using X11 forwarding and ended up installing and launching xfce (`apt install xfce4`) to run Qt Creator.
Expand All @@ -69,25 +76,34 @@ Note: HIDAPI should be cloned into this project's parent directory (or clone the

1. In non-root Shell, add Qt5 to PATH, fe.:

```
PATH=$PATH:~/Qt/5.13.2/gcc_64/bin
QT_QPA_PLATFORM_PLUGIN_PATH=~/Qt/5.13.2/gcc_64/plugins
QT_QPA_PLATFORM_PLUGIN_PATH=~/Qt/5.13.2/gcc_64/plugins
```

1. Change directory to HIDAPI, fe.:

```
cd ~/TeensyFanController/HIDAPI
```

1. Run qmake:

```
qmake
```

1. Run nmake:
1. Run make:

```
make
```

1. Verify libHIDAPI.a was created:

```
ls linux/libHIDAPI.a

```

Building the Fan Controller UI:

Expand Down

0 comments on commit 99392e3

Please sign in to comment.