Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add small tutorial for compilation on Linux #10

Merged
merged 1 commit into from
May 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 31 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,39 @@
# Pinecil Firmware Updater
Application for updating Pine64's Pinecil soldering iron.

# Supported platforms
## Supported platforms

- [X] Windows 7 - 10 (64-bit)
- [X] MacOS
- [ ] Linux
- [X] Linux

# Screenshots
## How to compile (and run)

![Screenshot 1](https://i.imgur.com/WYzyAUE.png)
![Screenshot 2](https://i.imgur.com/BmVQINS.png)
### Windows, MAC

Download the binaries from the [releases page](https://github.com/pine64/pinecil-firmware-updater/releases)

### Linux

The following steps assume you have the Qt, dfu-util and libusb dependencies
already installed. Depending on your actual Linux distribution these dependencies
might have slightly different names, and can be installed through your favourite
package manager.


```
# Create make file using Qt
qmake
# Build
make
# Link dfu-util symbolically to this folder
ln -s /usr/bin/dfu-util .
# Run the tool
sudo ./pinecil_firmware_updater
```

## Screenshots

![Screenshot 1 - Windows](https://i.imgur.com/WYzyAUE.png)
![Screenshot 2 - Mac](https://i.imgur.com/BmVQINS.png)
![Screenshot 3 - Linux](https://i.imgur.com/FOVMO4P.png)
2 changes: 2 additions & 0 deletions pinecil_firmware_updater.pro
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ macx: LIBS += -L$$PWD/deps/libusb/lib/ -lusb-1.0
macx: INCLUDEPATH += $$PWD/deps/libusb/include
macx: DEPENDPATH += $$PWD/deps/libusb/include

unix:!android: LIBS += -lusb-1.0

DISTFILES += \
pinecil-instructions.png

Expand Down