Skip to content

Commit

Permalink
chore: Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
mfep committed May 25, 2024
1 parent 32f0138 commit 86193b3
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 11 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[![License badge](https://img.shields.io/github/license/mfep/exercise-timer)](./LICENSE.txt)
[![Flathub badge](https://img.shields.io/flathub/downloads/xyz.safeworlds.hiit?logo=flathub&logoColor=white)](https://flathub.org/apps/details/xyz.safeworlds.hiit)
![Platforms badge](https://img.shields.io/badge/platform-linux-informational)
![Translations badge](https://hosted.weblate.org/widget/exercise-timer/exercise-timer/svg-badge.svg?native=1)

Exercise timer is a simple utility to conduct interval training. It is built for the GNOME desktop using [libadwaita](https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1.4/index.html) and [Relm4](https://relm4.org/).

Expand Down Expand Up @@ -40,10 +41,10 @@ $ sudo dnf install -y flatpak-builder
$ flatpak remote-add --user --if-not-exists flathub-verified https://flathub.org/repo/flathub.flatpakrepo
```

3. If not present, install the GNOME 45 Flatpak runtime and SDK and the Freedesktop SDK Rust and LLVM extensions.
3. If not present, install the GNOME 46 Flatpak runtime and SDK and the Freedesktop SDK Rust and LLVM extensions.

```bash
$ flatpak install --user org.gnome.{Sdk,Platform}//45 org.freedesktop.Sdk.Extension.{rust-stable,llvm16}//23.08
$ flatpak install --user org.gnome.{Sdk,Platform}//46 org.freedesktop.Sdk.Extension.{rust-stable,llvm16}//23.08
```

4. Clone the current repository.
Expand All @@ -61,7 +62,13 @@ $ flatpak-builder --user --install --force-clean build ./build-aux/xyz.safeworld

## 🧑‍🤝‍🧑 Contributing

PRs and feedback in the form of issues is welcome. Please be considerate though, and try to provide complete reports and code.
### Translations

Exercise Timer is translated via [Weblate](https://hosted.weblate.org/projects/exercise-timer/exercise-timer/). Fixes to existing translations as well as translating to new languages are welcome!

### Development

PRs and feedback in the form of issues are most welcome.

## ✍️ License

Expand Down
4 changes: 2 additions & 2 deletions data/screenshots/dark_exercise_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions data/screenshots/dark_timer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions data/screenshots/light_exercise_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions data/screenshots/light_timer.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 86193b3

Please sign in to comment.