Skip to content

Commit 4b35141

Browse files
committed
README.md: Fixed markdown issues and updated installation instructions
1 parent 88f0959 commit 4b35141

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,13 @@ Hover is part of the [go-flutter](https://github.com/go-flutter-desktop/go-flutt
1010

1111
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.
1212

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:
1416

1517
```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
1919
```
20-
Go 1.13 is required and `GO111MODULE` must not be set to `on` (`auto` and `off` is fine)
2120

2221
Run the same command to update when a newer version becomes available.
2322

@@ -27,10 +26,10 @@ Install these dependencies:
2726
The recommended C compiler are documented [here](https://github.com/golang/go/wiki/InstallFromSource#install-c-tools).
2827

2928
* 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.
3433

3534
## Getting started with an existing Flutter project
3635

@@ -60,11 +59,9 @@ It's the following code before `runApp(..)` that makes Flutter run on other plat
6059
debugDefaultTargetPlatformOverride = TargetPlatform.fuchsia;
6160
```
6261

63-
6462
Optionally, you may add [plugins](https://github.com/go-flutter-desktop/plugins) to `go/cmd/options.go`
6563
Optionally, change the logo in `go/assets/logo.png`, which is used as icon for the window.
6664

67-
6865
### Run with hot-reload
6966

7067
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:
9491
```bash
9592
hover build linux # or darwin or windows
9693
```
94+
9795
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.
9997

10098
The output will be in `go/build/outputs/linux` or windows or darwin.
10199

@@ -108,27 +106,32 @@ To start the binary: (replace `yourApplicationName` with your app name)
108106
It's possible to zip the whole dir `go/build/outputs/linux` and ship it to a different machine.
109107

110108
### Packaging
109+
111110
You can package your application for different packaging formats.
112111
First initialize the packaging format:
112+
113113
```bash
114114
hover init-packaging linux-appimage
115115
```
116+
116117
Update the configuration files located in `go/packaging/linux-appimage/`to your needs.
117118
Then create a build and package it using this command:
119+
118120
```bash
119121
hover build linux-appimage
120122
```
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/`
122125

123126
To get a list of all available packaging formats run:
127+
124128
```bash
125129
hover build --help
126130
```
127131

128132
## Fonts
129133

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.
132135

133136
## Issues
134137

0 commit comments

Comments
 (0)