Skip to content

Commit

Permalink
Add a demo GIF to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
jeandeaual committed Apr 30, 2020
1 parent 42e3fe1 commit 9a6fd7a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
1 change: 1 addition & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ name: build
on:
push:
branches: [master]
tags: [v*]
pull_request:
branches: [master]
jobs:
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Generate card decks for [Tabletop Simulator](https://www.tabletopsimulator.com/)

Inspired by [decker](https://github.com/Splizard/decker) and [Frogtown](https://www.frogtown.me/).

![Demo](demo.gif)

## Features

* Generate a Tabletop Simulator deck with thumbnail from an existing website or file.
Expand Down Expand Up @@ -58,7 +60,9 @@ Inspired by [decker](https://github.com/Splizard/decker) and [Frogtown](https://

The latest version is available [here](https://github.com/jeandeaual/tts-deckconverter/actions?query=workflow%3Abuild).

Click on the topmost job, then download the appropriate package for your machine from the artifact list.
Click on the topmost job, then download the appropriate package for your machine from the artifact list (e.g. `tts-deckconverter-gui-windows-amd64` for the Windows GUI or `tts-deckconverter-windows-amd64` for the Windows command-line interface).

You can just run the program, no installation is required.

## Building

Expand All @@ -82,7 +86,7 @@ $ go build ./cmd/tts-deckconverter-gui

This will generate an executable called `tts-deckconverter-gui`.

## Usage
## CLI usage

```
$ ./tts-deckconverter -h
Expand Down Expand Up @@ -118,7 +122,7 @@ Flags:
display the version information
```

### Samples usages
### Usage examples

* Generate `Angelic Arrmy.json` under the TTS Saved Objects folder (`%USERPROFILE%/Documents/My Games/Tabletop Simulator/Saves/Saved Objects` on Windows):

Expand Down
Binary file added demo.gif
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 9a6fd7a

Please sign in to comment.