Merge branch 'master' into develop

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'unverified'
+assignees: ''
+
+---
+
+<!-- Please search for open issues that relate to the same problem before opening a new one. -->
+
+### Describe the bug:
+<!-- A clear and concise description about the bug. -->
+
+
+### To Reproduce:
+Steps to reproduce the behaviour:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Screenshots:
+<!-- If applicable, add screenshots or gifs to help explain your problem. -->
+
+
+### Example code:
+<!-- If applicable, add a short code snippet to help explain and simplify reproduction of the problem. -->
+<!-- Please write the code inside a code block with go syntax, like this:
+```go
+Write your code here.
+```
+-->
+
+
+### Device (please complete the following information):
+ - **OS:** <!-- [e.g. Linux, MacOS or iOS] -->
+ - **Version:** <!-- [e.g. 5.10.2, 10.13 High Sierra or 14.2] -->
+ - **Go version:** <!-- [e.g. 1.12.3] -->
+ - **FyneDesk version:** <!-- [e.g. 0.2.0 or git SHA] -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+contact_links:
+ - name: Ask a question
+ url: https://fyne.io/support/
+ about: For a toolkit question or help with your code go to our support page

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!-- Please search for open issues that relate to the same feature before opening a new one. -->
+
+### Is your feature request related to a problem? Please describe:
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+### Is it possible to construct a solution with the existing API?
+<!-- If this is an enhancement have you been able to create something similar,
+or is your desired outcome not possible at this time? -->
+
+### Describe the solution you'd like to see:
+<!-- A clear and concise description of what you want to happen. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+<!-- If this is your first pull request for Fyne please read the contributor docs at:
+https://github.com/fyne-io/fyne/wiki/Contributing.
+Be sure that your work is based off `develop` branch. --> 
+
+### Description:
+<!-- A summary of the change included and which issue it addresses.
+Please include any relevant motivation and background. -->
+
+Fixes #(issue)
+
+### Checklist:
+<!-- Please tick these as appropriate using [x] -->
+
+- [ ] Tests included.
+- [ ] Lint and formatter run with no errors.
+- [ ] Tests all pass.
+
+#### Where applicable:
+<!-- Please delete these if not required for this PR -->
+
+- [ ] Public APIs match existing style.
+- [ ] Any breaking changes have a deprecation path or have been discussed.
+- [ ] Updated the vendor folder (using `go mod vendor`).

README.md

@@ -12,7 +12,7 @@
 # About
 
 FyneDesk is an easy to use Linux/Unix desktop environment following material design.
-It is build using the [Fyne](https://fyne.io) toolkit and is designed to be
+It is built using the [Fyne](https://fyne.io) toolkit and is designed to be
 easy to use as well as easy to develop. We use the Go language and welcome
 any contributions or feedback for the project.
 
@@ -27,18 +27,34 @@ Compositor support currently requires `compton` to be installed.
 
 # Getting Started
 
-Using standard go tools you can install FyneDesk using:
+Using standard Go tools you can install FyneDesk using:
 ```
 go get fyne.io/fynedesk/cmd/fynedesk
 ```
 
-Once installed you can run the following commands from the root of the installed fynedesk folder (usually $GOPATH/src/fyne.io/fynedesk/) to set up fynedesk as a selectable desktop option in your login manager (such as LightDM for example).
+This will add `fynedesk` to your $GOPATH (usually ~/go/bin).
+You can now run the app in "preview" mode like any other Fyne app.
+Doing so is not running a window manager, to do so requires another few steps:
+
+## Setting up as a desktop environment
+
+To use this as your main desktop you can run the following commands to set up
+fynedesk as a selectable desktop option in your login manager (such as LightDM for example):
+
 ```
+git clone https://github.com/fyne-io/fynedesk
+cd fynedesk
 make
 sudo make install
 ```
 
-You can also run it in an embedded X window for testing using:
+You can now log out and see that it is in your desktop selection list at login.
+
+## Debugging a window manager
+
+You can also run the window manager components in an embedded X window for testing.
+You will need the `Xephyr` tool installed for your platform (often installed as part of Xorg).
+Once it is present you can use the following command from the same directory as above:
 
  make embed
 
@@ -56,14 +72,14 @@ controlling of windows - they will load on your main desktop.
 
 # Runner
 
-A desktop needs to be rock solid and, whilst we are working hard to get there,
-any alpha or beta software can run in to unexpected issues. 
-For that reason we have included a `fynedesk_runner` utility that can help
-manage unexpected events. If you start the desktop using the runner then
-if a crash occurs it will normally recover where it left off with no loss
+A desktop needs to be rock solid, and whilst we are working hard to get there,
+any alpha or beta software can run into unexpected issues. 
+For that reason, we have included a `fynedesk_runner` utility that can help
+manage unexpected events. If you start the desktop using the runner, then
+if a crash occurs, it will normally recover where it left off with no loss
 of data in your applications.
 
-Using standard go tools you can install the runner using:
+Using standard Go tools you can install the runner using:
 
  go get fyne.io/fynedesk/cmd/fynedesk_runner