You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-15Lines changed: 18 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,13 @@ Hover is part of the [go-flutter](https://github.com/go-flutter-desktop/go-flutt
10
10
11
11
Hover uses [Go](https://golang.org) to build your Flutter application to desktop. Hover itself is also written using the Go language. You will need to [install go](https://golang.org/doc/install) on your development machine.
12
12
13
-
Then install hover like this:
13
+
Run `go version` and make sure that your Go version is 1.13 or higher.
14
+
15
+
Then install hover by running this in your home directory:
14
16
15
17
```bash
16
-
$ go version
17
-
go version go1.13 XX/YYY
18
-
$ go get -u github.com/go-flutter-desktop/hover
18
+
GO111MODULE=on go get -u -a github.com/go-flutter-desktop/hover
19
19
```
20
-
Go 1.13 is required and `GO111MODULE` must not be set to `on` (`auto` and `off` is fine)
21
20
22
21
Run the same command to update when a newer version becomes available.
23
22
@@ -27,10 +26,10 @@ Install these dependencies:
27
26
The recommended C compiler are documented [here](https://github.com/golang/go/wiki/InstallFromSource#install-c-tools).
28
27
29
28
* You need to make sure you have dependencies of GLFW:
30
-
* On macOS, you need Xcode or Command Line Tools for Xcode (`xcode-select --install`) for required headers and libraries.
31
-
* On Ubuntu/Debian-like Linux distributions, you need `libgl1-mesa-dev xorg-dev` packages.
32
-
* On CentOS/Fedora-like Linux distributions, you need `libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel mesa-libGL-devel libXi-devel` packages.
33
-
* See [here](http://www.glfw.org/docs/latest/compile.html#compile_deps) for full details.
29
+
* On macOS, you need Xcode or Command Line Tools for Xcode (`xcode-select --install`) for required headers and libraries.
30
+
* On Ubuntu/Debian-like Linux distributions, you need `libgl1-mesa-dev xorg-dev` packages.
31
+
* On CentOS/Fedora-like Linux distributions, you need `libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel mesa-libGL-devel libXi-devel` packages.
32
+
* See [here](http://www.glfw.org/docs/latest/compile.html#compile_deps) for full details.
34
33
35
34
## Getting started with an existing Flutter project
36
35
@@ -60,11 +59,9 @@ It's the following code before `runApp(..)` that makes Flutter run on other plat
Optionally, you may add [plugins](https://github.com/go-flutter-desktop/plugins) to `go/cmd/options.go`
65
63
Optionally, change the logo in `go/assets/logo.png`, which is used as icon for the window.
66
64
67
-
68
65
### Run with hot-reload
69
66
70
67
To run the application and attach flutter for hot-reload support:
@@ -94,8 +91,9 @@ To create a standalone release (JIT mode) build run this command:
94
91
```bash
95
92
hover build linux # or darwin or windows
96
93
```
94
+
97
95
You can create a build for any of the supported OSs using cross-compiling which needs [Docker to be installed](https://docs.docker.com/install/).
98
-
Then just run the command from above and it will do everything for you.
96
+
Then run the command from above and it will do everything for you.
99
97
100
98
The output will be in `go/build/outputs/linux` or windows or darwin.
101
99
@@ -108,27 +106,32 @@ To start the binary: (replace `yourApplicationName` with your app name)
108
106
It's possible to zip the whole dir `go/build/outputs/linux` and ship it to a different machine.
109
107
110
108
### Packaging
109
+
111
110
You can package your application for different packaging formats.
112
111
First initialize the packaging format:
112
+
113
113
```bash
114
114
hover init-packaging linux-appimage
115
115
```
116
+
116
117
Update the configuration files located in `go/packaging/linux-appimage/`to your needs.
117
118
Then create a build and package it using this command:
119
+
118
120
```bash
119
121
hover build linux-appimage
120
122
```
121
-
The packaging output will be located in `go/build/outputs/linux-appimage/`
123
+
124
+
The packaging output is placed in `go/build/outputs/linux-appimage/`
122
125
123
126
To get a list of all available packaging formats run:
127
+
124
128
```bash
125
129
hover build --help
126
130
```
127
131
128
132
## Fonts
129
133
130
-
No text visible? Make sure to use fonts who are included in the flutter assets/fonts system. The default font for `MaterialApp`, Roboto, is not installed on all machines.
131
-
134
+
No text visible? Make sure to use fonts that are included in the flutter assets/fonts system. The default font for `MaterialApp`, Roboto, is not installed on all machines.
0 commit comments