Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
unlimitedbacon authored Jul 27, 2018
1 parent 6917bce commit a8067e1
Showing 1 changed file with 28 additions and 8 deletions.
36 changes: 28 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,29 @@ Stl-thumb is a fast lightweight thumbnail generator for STL files. It can show p

### Windows

1. Install the [Microsoft Visual C++ 2015 Redistributable](https://www.microsoft.com/en-us/download/details.aspx?id=52685). There is a good chance you already have this.
2. Download the MSI package from the Releases and install it.
Stl-thumb requires 64 bit Window Vista or later. [Download the installer .exe](https://github.com/unlimitedbacon/stl-thumb/releases/latest) for the latest release and run it.

The installer will tell the Windows shell to refresh the thumbnail cache, however this does not always seem to work. If your icons do not change then try using the Disk Cleanup utility to clear the thumbnail cache.
The installer will tell the Windows shell to refresh the thumbnail cache, however this does not always seem to work. If your icons do not change then try using the [Disk Cleanup](https://en.wikipedia.org/wiki/Disk_Cleanup) utility to clear the thumbnail cache.

### Linux

Packages are being worked on for Arch and Debian/Ubuntu. Make sure your file manager is set to create previews for files > 1 Mb.
Stl-thumb does not currently work with Nautilus (Gnome Files) 3.26. This is the default file manager in Ubuntu 18.04. [Nautilus sandboxes the thumbnailers](https://gitlab.gnome.org/GNOME/gnome-desktop/issues/7), preventing us from using GL. For now you will have to use a different file manager instead.

#### Arch

A package is available [in the AUR](https://aur.archlinux.org/packages/stl-thumb/). Install it manually or using your favorite AUR helper.

```
$ yay -S stl-thumb
```

#### Debian / Ubuntu

[Download the .deb package](https://github.com/unlimitedbacon/stl-thumb/releases/latest) for your platform (usually amd64) and install it.

```
$ sudo dpkg -i stl-thumb_0.1.0_amd64.deb
```

## Command Line Usage

Expand All @@ -27,7 +42,12 @@ $ stl-thumb <STL_FILE> [IMG_FILE]

### Options

| Option | Description |
| ----------- | ------------------------------------------------------- |
| -s \<size\> | Specify width of the image. It will always be a square. |
| -x | Show a preview. |
| Option | Description |
| ------------- | ------------------------------------------------------- |
| <STL_FILE> | The STL file you want a picture of. |
| [IMG_FILE] | The thumbnail image file that will be created. Always PNG format. If this is omitted, the image data will be dumped to stdout. |
| -s \<size\> | Specify width of the image. It will always be a square. |
| -x | Display the image in a window. |
| -h, --help | Prints help information. |
| -V, --version | Prints version information. |
| -v[v][v] | Increase message verbosity. |

0 comments on commit a8067e1

Please sign in to comment.