Skip to content

Commit de37529

Browse files
teamconsteamcons
committed
Add templating, funding, rework the README
1 parent 7fea593 commit de37529

5 files changed

Lines changed: 186 additions & 26 deletions

File tree

‎.github/FUNDING.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
ko_fi: akzel94
2+
ko_fi: teamcons

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Bug Report
2+
description: File a bug report
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thank you for taking the time to fill out this bug report!
8+
- type: textarea
9+
id: what-happened
10+
attributes:
11+
label: What happened?
12+
description: Please provide a clear and concise description of the bug.
13+
placeholder: The program crashed
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: Steps to reproduce
19+
description: Provide step by step instructions to reproduce the bug if possible
20+
placeholder:
21+
1. Go to ...
22+
23+
2. Click on ...
24+
25+
3. Scroll down to ...
26+
27+
4. See error
28+
- type: textarea
29+
attributes:
30+
label: What was expected?
31+
description: Explain what you expected the program to do and why?
32+
placeholder: The program should not have crashed. Cos duh!
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: Screenshots
38+
description: If applicable, add screenshots to help explain your problem
39+
- type: input
40+
attributes:
41+
label: OS name and version
42+
placeholder: elementary OS 6.1 Jólnir
43+
validations:
44+
required: true
45+
- type: input
46+
attributes:
47+
label: Version
48+
description: The version of picker you are using
49+
placeholder: 1.0.2
50+
validations:
51+
required: true
52+
- type: textarea
53+
attributes:
54+
label: Additional context
55+
description: Add any additional context about the problem here

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thank you for taking the time to propose a feature!
8+
- type: textarea
9+
id: problem-description
10+
attributes:
11+
label: Description
12+
description: Is your feature request related to a problem? then give a
13+
clear and concise description of what the problem is. Also describe your
14+
proposed solution. Feel free to go into as much detail as necessary.
15+
placeholder: I'm always having trouble with... it would be nice to have...
16+
- type: textarea
17+
attributes:
18+
label: Reference and prior art
19+
description: If there are other apps, websites etc. that implement a
20+
solution to your problem or your proposed solution, mention them.
21+
Include screenshots, videos, links or any other helpful information.
22+
placeholder: app X implements a similar feature and you can find some
23+
images of how app Y does it here...
24+
- type: textarea
25+
attributes:
26+
label: Additional context
27+
description: provide any other additional context

‎.github/workflows/CI.yml‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: CI
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
# try building the app
7+
build:
8+
name: Build
9+
runs-on: ubuntu-latest
10+
container:
11+
image: elementary/docker:stable
12+
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v1
16+
17+
- name: Install dependencies
18+
env:
19+
dependency_packages: libvala-dev valac meson libgtk-3-dev libgranite-dev appstream
20+
run: apt update && apt -y install ${dependency_packages}
21+
22+
- name: Build
23+
run: |
24+
meson build
25+
ninja -C build
26+
ninja -C build install
27+
28+
# build a flatpak
29+
flatpak:
30+
name: Flatpak
31+
runs-on: ubuntu-latest
32+
# no point in running flatpak packaging if normal build has failed
33+
needs: build
34+
35+
# This job runs in a special container designed for building Flatpaks for AppCenter
36+
container:
37+
image: ghcr.io/elementary/flatpak-platform/runtime:7
38+
options: --privileged
39+
40+
steps:
41+
- name: Checkout
42+
uses: actions/checkout@v2
43+
44+
# Builds flatpak manifest using the Flatpak Builder action
45+
- name: Flatpak
46+
uses: bilelmoussaoui/flatpak-github-actions/flatpak-builder@v3
47+
with:
48+
# This is the name of the Bundle file we're building
49+
bundle: Cherrypick.flatpak
50+
manifest-path: io.github.ellie_commons.cherrypick.yml
51+
52+
run-tests: false
53+
54+
# These lines specify the location of the elementary Runtime and Sdk
55+
repository-name: appcenter
56+
repository-url: https://flatpak.elementary.io/repo.flatpakrepo
57+
cache-key: "flatpak-builder-${{ github.sha }}"
58+
59+
# check for code style errors
60+
lint:
61+
name: Lint
62+
runs-on: ubuntu-latest
63+
container:
64+
image: valalang/lint
65+
66+
steps:
67+
- name: Checkout
68+
uses: actions/checkout@v2
69+
70+
- name: Lint
71+
run: io.elementary.vala-lint -d .

‎README.md‎

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,47 @@
1-
<p align="center">
2-
<img src="data/icons/128.svg" alt="Icon" />
3-
</p>
4-
<h1 align="center">Roll-It</h1>
5-
<p align="center">
6-
<a href="https://appcenter.elementary.io/io.github.ellie_commons.rollit"><img src="https://appcenter.elementary.io/badge.svg" alt="Get it on AppCenter" /></a>
7-
</p>
81

9-
| ![Screenshot](data/screenshots/screenshot1.png) | ![Screenshot](data/screenshots/screenshot2.png) |
10-
|------------------------------------------|-----------------------------------------|
2+
<div align="center">
3+
<img alt="An icon representing a six-sided dice, showing a three" src="data/icons/128.svg" />
4+
<h1>Roll-It</h1>
5+
<h3>Simply roll a dice</h3>
6+
</div>
117

12-
## Roll the dice
13-
14-
Simulate the results of rolling a die. Roll a six-sided die by default, or get the results of rolling a custom die with up to one-hundred sides.
8+
<span align="center"> <img class="center" src="https://github.com/ellie-commons/rollit/blob/main/data/screenshots/screenshot1.png" alt="A screenshot of a window displaying a dice result and a history of past rolls"></span>
9+
</div>
1510

1611
## Installation
1712

1813
Roll-It is designed and developed primarily for [elementary OS]. The latest stable release is available via AppCenter.
1914

20-
[![Get it on AppCenter](https://appcenter.elementary.io/badge.svg)][AppCenter link]
15+
[![Get it on AppCenter](https://appcenter.elementary.io/badge.svg?new)](https://appcenter.elementary.io/io.github.ellie_commons.rollit)
2116

22-
Any version distributed elsewhere is not provided nor supported by me.
2317

24-
## Building
18+
It is the updated, older codebase of Chance, which once was an elementary OS, but is now on Flathub and for GNOME systems:
2519

26-
### Flatpak
20+
The code is originally from @zelikos, who allowed us to update it for elementary OS
2721

28-
First, install the elementary Flatpak runtime & SDK:
22+
[<img src="https://flathub.org/assets/badges/flathub-badge-en.svg" width="160" alt="Download on Flathub">](https://flathub.org/apps/dev.zelikos.rollit)
23+
24+
## 💝 Donations
25+
26+
On the right you can donate to various contributors:
27+
- Akzel/Zelikos, the original author
28+
- teamcons, the main devs and maintainers behind this updated
2929

30-
```shell
31-
flatpak remote-add --if-not-exists appcenter https://flatpak.elementary.io/repo.flatpakrepo
32-
flatpak install appcenter io.elementary.Platform//6.1 io.elementary.Sdk//6.1
33-
```
3430

35-
Then, to build and install Roll-It:
31+
## 🏗️ Building
3632

37-
```shell
38-
flatpak-builder build io.github.ellie_commons.rollit.yml --user --install --force-clean
33+
Installation is as simple as installing the above, downloading and extracting the zip archive, changing to the new repo's directory,
34+
and run the following command:
35+
36+
### On elementary OS or with its appcenter remote installed
37+
38+
```bash
39+
flatpak-builder --force-clean --user --install-deps-from=appcenter --install builddir ./io.github.ellie_commons.rollit.yml
3940
```
4041

41-
[elementary OS]: https://elementary.io
42-
[AppCenter link]: https://appcenter.elementary.io/io.github.ellie_commons.rollit
42+
### On other systems:
43+
44+
First, install the elementary Flatpak runtime & SDK:
45+
46+
flatpak remote-add --if-not-exists appcenter https://flatpak.elementary.io/repo.flatpakrepo
47+
flatpak install appcenter io.elementary.Platform//8.2 io.elementary.Sdk//8.2

0 commit comments

Comments
 (0)