Skip to content

Commit 21b4875

Browse files
docs: Post-Circle update (#116)
Since Keypunch is now part of GNOME Circle, update a few links and add some text to reflect that.
1 parent e31a0d6 commit 21b4875

File tree

4 files changed

+26
-34
lines changed

4 files changed

+26
-34
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,6 @@
11
# Contributing
22

3-
Thanks for your interest in contributing to Keypunch! Here are some useful things to know:
4-
5-
## Issues and suggestions
6-
7-
Bug reports and feature requests are welcome. However, please keep the following in mind:
8-
9-
- Flatpak is the only officially supported packaging format
10-
- The app has a [conservative approach to preferences](https://ometer.com/preferences.html); things should ideally be good enough out of the box
11-
- Before making a change and opening a pull request, make sure to discuss it in the issue tracker first, to make sure that the change will be accepted
12-
- This project follows the [GNOME Code of Conduct](https://conduct.gnome.org)
13-
14-
## Building
15-
16-
Use the Flatpak version of [GNOME Builder](https://apps.gnome.org/Builder) to build and run the project from source:
17-
18-
1. Open Builder and press the "Clone Repository…" button
19-
2. Paste a link to the repository in the "Repository URL" field:
20-
21-
```
22-
https://github.com/bragefuglseth/keypunch
23-
```
24-
25-
3. Press the "Clone repository…" button
26-
4. Press confirm if asked about automatic installation of any dependencies, and wait for them to download
27-
5. Press the play button in the header bar
28-
29-
## Translating
30-
31-
Keypunch does not have any external translation infrastructure as of now, but a slot on Weblate will be applied for as soon as the project meets the requirements. Until then, please submit translations as regular pull requests. Translation work happens in the `po` directory.
3+
Thanks for your interest in contributing to Keypunch! Most of the information you're looking for can likely be found in Keypunch's [contribution guide](https://welcome.gnome.org/app/Keypunch) on the Welcome to GNOME website. This document contains information specific to Keypunch that cannot be found in said contribution guide.
324

335
## Adding a Language
346

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
[![Available on Flathub](https://img.shields.io/flathub/downloads/dev.bragefuglseth.Keypunch?logo=flathub&labelColor=77767b&color=4a90d9)](https://flathub.org/apps/dev.bragefuglseth.Keypunch)
66
[![Chat on Matrix](https://img.shields.io/badge/chat-%23keypunch%3Agnome.org-mediumorchid?style=flat&logo=matrix)](https://matrix.to/#/#keypunch:gnome.org)
7+
[![Proudly part of GNOME Circle](https://circle.gnome.org/assets/button/badge.svg)](https://circle.gnome.org)
78
[![Please do not theme this app](https://stopthemingmy.app/badge.svg)](https://stopthemingmy.app)
89

910
![screenshot](/data/screenshots/2-ready.png)
@@ -22,9 +23,25 @@ Keypunch is available on Flathub.
2223

2324
[<img width="240" alt="Download on Flathub" src="https://flathub.org/api/badge?svg&locale=en"/>](https://flathub.org/apps/dev.bragefuglseth.Keypunch)
2425

26+
## GNOME Circle
27+
28+
Keypunch is proudly part of GNOME Circle, an initiative that champions the
29+
great software that is available for the GNOME platform. For more information,
30+
visit the GNOME Circle website.
31+
32+
[<img width="240" src="https://circle.gnome.org/assets/button/circle-button-fullcolor.svg">](https://circle.gnome.org)
33+
2534
## Contributing
2635

27-
Contributions are welcome! Refer to [CONTRIBUTING.md](CONTRIBUTING.md) for more. This project follows the [GNOME Code of Conduct](https://conduct.gnome.org).
36+
## Contributing
37+
38+
Contributions are extremely welcome. To see how you can help with issue reporting, development, and translations, consult Keypunch's [contribution guide](https://welcome.gnome.org/app/Keypunch). For project-specific documentation, such as how to add a new text language, see [CONTRIBUTING.md](CONTRIBUTING.md).
39+
40+
Please take this into consideration as well:
41+
42+
- This project follows the [GNOME Code of Conduct](https://conduct.gnome.org).
43+
- Only Flatpak is officially supported.
44+
- If you want to contribute major changes, please discuss them beforehand to verify that they are suitable for the project.
2845

2946
## Name
3047

data/dev.bragefuglseth.Keypunch.metainfo.xml.in.in

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@
3030
<p>
3131
Get ready to accelerate your typing!
3232
</p>
33+
<p>
34+
Keypunch is proudly part of GNOME Circle, an initiative that champions the great software that is available for the GNOME platform. For more information, visit the GNOME Circle website.
35+
</p>
3336
</description>
3437
<screenshots>
3538
<screenshot type="default">
@@ -57,10 +60,10 @@
5760
<color type="primary" scheme_preference="light">#c879ff</color>
5861
<color type="primary" scheme_preference="dark">#9a00d3</color>
5962
</branding>
60-
<url type="homepage">https://github.com/bragefuglseth/keypunch</url>
63+
<url type="homepage">https://apps.gnome.org/Keypunch</url>
6164
<url type="bugtracker">https://github.com/bragefuglseth/keypunch/issues</url>
62-
<url type="contribute">https://github.com/bragefuglseth/keypunch/blob/main/CONTRIBUTING.md</url>
63-
<url type="translate">https://github.com/bragefuglseth/keypunch/blob/main/CONTRIBUTING.md#translating</url>
65+
<url type="contribute">https://welcome.gnome.org/app/Keypunch</url>
66+
<url type="translate">https://github.com/bragefuglseth/keypunch/tree/main/po</url>
6467
<url type="vcs-browser">https://github.com/bragefuglseth/keypunch</url>
6568
<url type="contact">https://matrix.to/#/#keypunch:gnome.org</url>
6669
<update_contact>bragefuglseth_AT_gnome.org</update_contact>

keypunch.doap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<name xml:lang="en">Keypunch</name>
88
<shortdesc xml:lang="en">Practice your typing skills</shortdesc>
9-
<homepage rdf:resource="https://github.com/bragefuglseth/keypunch" />
9+
<homepage rdf:resource="https://apps.gnome.org/Keypunch" />
1010
<bug-database rdf:resource="https://github.com/bragefuglseth/keypunch/issues" />
1111

1212
<programming-language>Rust</programming-language>

0 commit comments

Comments
 (0)