Skip to content

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
janpfeifer committed Jun 23, 2021
1 parent 5a9cacf commit 6ac1255
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 7 deletions.
57 changes: 50 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,56 @@ communication tools.

(*) Anyone willing to contribute with a MacOS port? Maybe in Chromebooks as well ?

## Configuring Global Shortcut (Hotkey)
## Installation

### Windows
### Windows (10)

There is no installation tool yet, so one needs to download the ".exe" file and
place it in your favourite location. At home, I created a directory `c:\Tools` and
I put manually installed binaries there.

#### Assigning to shortcut key (hotkey)

In Windows 10 a *shortcut key* can be easily assigned to a "shortcut file" **in the Desktop**.
Elsewhere, it doesn't seem to work ... despite Windows allowing to set the shortcut, not sure what
was the logic the engineers had in their mind here.

Right-click on the desktop, create a shortcut and point it to where you installed your GoShot `.exe`
file. Then right-click on the "shortcut file", in the Desktop, and assign a "shortcut key", which can
be assigned to a "Control+Alt+<some key>" combination.

<img src="docs/win_shortcut_1.png" alt="Windows Shortcut Key set up"/>

#### Running in the System Tray

Alternatively, run GoShot with `--systray`, to have it show up as an icon in your system tray,
from where you can select "Screenshot" anytime (with the mouse though).

Create a "shortcut file", and add the --systray option.

<img src="docs/win_shortcut_2.png" alt="Windows Shortcut Key set up"/>

### Linux: Gnome+Cinnamon

Alternatively, run GoShot with `--systray`, to have it show up as an icon in your system tray,
from where you can select "Screenshot" anytime (with the mouse though).

### Using [Go](golang.org)
If you have the [Go language](golang.org) installed you can also simply do:

```shell
$ go install github.com/janpfeifer/goshot@latest
```

## Extras
It will compile (take a couple of minutes) and show up in your Go directory.

### Running in the System Tray

It shows up as an icon in your system tray, from where you can select "Screenshot" anytime (with the mouse though).

```shell
$ goshot --systray
```
* --systray: It will run and open an icon on the system tray, from where one can start a shortcut.

## License
Expand All @@ -49,16 +90,18 @@ using Google Drive.

Other than that, it will save and/or share images at your request.

## Known issues
## Known issues and feature requests:

* **MacOS (Darwin)** support: I don't have access to a Mac to develop the parts not supported by [Fyne](https://github.com/fyne-io/fyne).

* Mac (Darwin) support: I don't have access to a Mac to develop the parts not supported by [Fyne](https://github.com/fyne-io/fyne).
* Add a **delayed time screenshot**: for those cases where one wants to screenshot things like an opened menu.

* Needs better icons/design :(
* Needs **better icons** and design -- I'm terrible at those :(

* Implement scrollbars on the side of the image editor: the native [Fyne](https://github.com/fyne-io/fyne) won't work.
Instead, one needs to move the image around by dragging, or using the minimap.

* Export to Microsoft OneDrive, DropBox, others ? -- I don't have account on those, contributions are very welcome!
* Export to **Microsoft OneDrive**, **DropBox**, **others** ? -- I don't have account on those, contributions are very welcome!

* If running in the system tray, automatically add a global shortcut.

Expand Down
Binary file added docs/win_shortcut_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/win_shortcut_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6ac1255

Please sign in to comment.