11<p align =" center " >
2- <a href =" https://godoc.org/fyne.io /fynedesk " title =" GoDoc Reference " rel =" nofollow " ><img src =" https://img.shields.io/badge/go-documentation-blue.svg?style=flat " alt =" GoDoc Reference " ></a >
2+ <a href =" https://godoc.org/fyshos.com /fynedesk " title =" GoDoc Reference " rel =" nofollow " ><img src =" https://img.shields.io/badge/go-documentation-blue.svg?style=flat " alt =" GoDoc Reference " ></a >
33 <a href =" https://github.com/fyshos/fynedesk/releases/tag/v0.4.0 " title =" 0.4.0 Release " rel =" nofollow " ><img src =" https://img.shields.io/badge/version-0.4.0-blue.svg?style=flat " alt =" 0.4.0 release " ></a >
44 <a href =' http://gophers.slack.com/messages/fynedesk ' ><img src =' https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=blue ' alt =' Join us on Slack ' /></a >
55
66 <br />
7- <a href =" https://goreportcard.com/report/fyne.io /fynedesk " ><img src =" https://goreportcard.com/badge/fyne.io /fynedesk " alt =" Code Status " /></a >
7+ <a href =" https://goreportcard.com/report/fyshos.com /fynedesk " ><img src =" https://goreportcard.com/badge/fyshos.com /fynedesk " alt =" Code Status " /></a >
88 <a href =" https://github.com/fyshos/fynedesk/actions " ><img src =" https://github.com/fyshos/fynedesk/workflows/Platform%20Tests/badge.svg " alt =" Build Status " /></a >
99 <a href =' https://coveralls.io/github/fyshos/fynedesk?branch=develop ' ><img src =' https://coveralls.io/repos/github/fyshos/fynedesk/badge.svg?branch=develop ' alt =' Coverage Status ' /></a >
1010</p >
1111
12- # About
12+ # About FyneDesk
1313
1414FyneDesk is an easy to use Linux/Unix desktop environment following material design.
1515It is built using the [ Fyne] ( https://fyne.io ) toolkit and is designed to be
@@ -18,28 +18,35 @@ any contributions or feedback for the project.
1818
1919[ ![ FyneDesk v0.4] ( https://img.youtube.com/vi/82Wu5k0xZOI/0.jpg )] ( https://www.youtube.com/watch?v=82Wu5k0xZOI )
2020
21- # Dependencies
21+ ## Dependencies
22+
23+ ### Compiling
24+
25+ Compiling requires the same dependencies as Fyne. See the [ Getting Started] ( https://developer.fyne.io/started/ ) documentation for installation steps.
26+
27+ ### Running
2228
2329For a full desktop experience you will also need the following external tools installed:
2430
25- - ` arandr `
31+ - ` arandr ` for modifying display settings
2632- ` xbacklight ` or ` brightnessctl ` for laptop brightness
2733- ` connman-gtk ` is currently used for configuring Wi-Fi network settings
34+ - ` compton ` for compositor support
2835
29- Compositor support currently requires ` compton ` to be installed .
36+ The desktop does work without the runtime dependencies but the experience will be degraded .
3037
31- # Getting Started
38+ ## Getting Started
3239
3340Using standard Go tools you can install FyneDesk using:
3441```
35- go get fyne.io /fynedesk/cmd/fynedesk
42+ go get fyshos.com /fynedesk/cmd/fynedesk
3643```
3744
3845This will add ` fynedesk ` to your $GOPATH (usually ~ /go/bin).
3946You can now run the app in "preview" mode like any other Fyne app.
4047Doing so is not running a window manager, to do so requires another few steps:
4148
42- ## Setting up as a desktop environment
49+ ### Setting up as a desktop environment
4350
4451To use this as your main desktop you can run the following commands to set up
4552fynedesk as a selectable desktop option in your login manager (such as LightDM for example):
@@ -53,7 +60,7 @@ sudo make install
5360
5461You can now log out and see that it is in your desktop selection list at login.
5562
56- ## Debugging a window manager
63+ ### Debugging a window manager
5764
5865You can also run the window manager components in an embedded X window for testing.
5966You will need the ` Xephyr ` tool installed for your platform (often installed as part of Xorg).
@@ -73,7 +80,7 @@ macOS) then the app will start in UI test mode.
7380When loaded in this way you can run all of the features except the
7481controlling of windows - they will load on your main desktop.
7582
76- # Runner
83+ ## Runner
7784
7885A desktop needs to be rock solid, and whilst we are working hard to get there,
7986any alpha or beta software can run into unexpected issues.
@@ -84,12 +91,16 @@ of data in your applications.
8491
8592Using standard Go tools you can install the runner using:
8693
87- go get fyne.io /fynedesk/cmd/fynedesk_runner
94+ go get fyshos.com /fynedesk/cmd/fynedesk_runner
8895
8996From then on execute that instead of the ` fynedesk ` command for a more
9097resilient desktop when testing out pre-release builds.
9198
92- # Shipping FyneDesk
99+ ## Design
100+
101+ Design concepts, and the abstract wallpapers have been contributed by [ Jost Grant] ( https://github.com/jostgrant ) .
102+
103+ ## Shipping FyneDesk
93104
94105If you are installing FyneDesk by default on a distribution, or making it available as a standard option, you should consider the following points.
95106You do not need to ship the library or any dependencies, but it is recommended to add the following apps as well:
0 commit comments