Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/esimov/gio-cloth
Browse files Browse the repository at this point in the history
  • Loading branch information
esimov committed Jan 9, 2023
2 parents 6199663 + 4c248d7 commit 57c96a1
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# gio-cloth
[![Build](https://github.com/esimov/gio-cloth/actions/workflows/build.yml/badge.svg)](https://github.com/esimov/gio-cloth/actions/workflows/build.yml)
[![License](https://img.shields.io/github/license/esimov/gio-cloth)](./LICENSE)
[![Release](https://img.shields.io/badge/release-v1.0.1-blue.svg)](https://github.com/esimov/gio-cloth/releases/tag/v1.0.1)

**gio-cloth** is a [Go](https://golang.org/) desktop application using [Gio](https://gioui.org) for 2D cloth physics simulation implementing [Verlet integration](https://en.wikipedia.org/wiki/Verlet_inteegration).

Expand All @@ -11,20 +14,22 @@ It has the following characteristics:
<p align="center"><img src="./cloth-sim.gif"/></p>

## How to run
Before running the application check the Gio [documentation](https://gioui.org/doc/install) for the system requirements.
Before running the application check the Gio [documentation](https://gioui.org/doc/install) for the system requirements. Install the required dependencies then type the following commands.

```bash
$ git clone https://github.com/esimov/gio-cloth
$ go run ./...
```

Another way to run it is to build the executable yourself then simply run it. If you don't have Go installed on your machine you can run the prebuild binary files from the project [packages](https://github.com/esimov/gio-cloth/packages) page.
Another way is to build the executable yourself then simply run it.

```bash
$ go build ./...
$ gio-cloth
```

If you don't have Go installed on your machine you can run the prebuild binary files from the project [packages](https://github.com/esimov/gio-cloth/packages) page.

## Supported key bindings:
* <kbd>SPACE</kbd> - Reset the cloth to the default values
* <kbd>RIGHT CLICK</kbd> - Make a hole in the cloth structure
Expand Down

0 comments on commit 57c96a1

Please sign in to comment.