Skip to content

Commit

Permalink
build: Use app ID with proper conventions, add contribution docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pojntfx committed Aug 26, 2023
1 parent 732354c commit 7e6cef9
Show file tree
Hide file tree
Showing 11 changed files with 1,031 additions and 46 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/flatpak.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ jobs:
- uses: actions/checkout@v3
- uses: flatpak/flatpak-github-actions/[email protected]
with:
bundle: com.pojtinger.felicitas.vintangle.flatpak
manifest-path: com.pojtinger.felicitas.vintangle.yaml
bundle: com.pojtinger.felicitas.Vintangle.flatpak
manifest-path: com.pojtinger.felicitas.Vintangle.yaml
cache-key: flatpak-builder-${{ github.sha }}
- name: Extract branch name
id: extract_branch
Expand Down
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ It enables you to ...

On Linux, Vintangle is available on Flathub:

<a href="https://flathub.org/apps/details/com.pojtinger.felicitas.vintangle"><img src="https://flathub.org/assets/badges/flathub-badge-en.png" width="200"/></a>
<a href="https://flathub.org/apps/details/com.pojtinger.felicitas.Vintangle"><img src="https://flathub.org/assets/badges/flathub-badge-en.png" alt="Flathub badge" width="200"/></a>

For other platforms, see [contributing](#contributing).

Expand Down Expand Up @@ -155,7 +155,16 @@ Click on an image to see a larger version.

## Contributing

🚧 This project is a work-in-progress! Instructions will be added as soon as it is usable. 🚧
To contribute, please use the [GitHub flow](https://guides.github.com/introduction/flow/) and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).

To build and start a development version of Vintangle locally, run the following:

```shell
$ git clone https://github.com/pojntfx/vintangle.git
$ cd vintangle
$ go generate ./...
$ go run .
```

## License

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ Version=1.0
Type=Application
Name=Vintangle
Comment=Synchronized torrent streaming for distributed watch parties.
Exec=com.pojtinger.felicitas.vintangle
Icon=com.pojtinger.felicitas.vintangle
Exec=vintangle
Icon=com.pojtinger.felicitas.Vintangle
Categories=AudioVideo;Video;Network
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<component type="desktop-application">
<id>com.pojtinger.felicitas.vintangle</id>
<id>com.pojtinger.felicitas.Vintangle</id>
<metadata_license>MIT</metadata_license>
<project_license>AGPL-3.0-or-later</project_license>
<name>Vintangle</name>
Expand Down Expand Up @@ -52,13 +52,14 @@
</screenshot>
</screenshots>

<launchable type="desktop-id">com.pojtinger.felicitas.vintangle.desktop</launchable>
<launchable type="desktop-id">com.pojtinger.felicitas.Vintangle.desktop</launchable>

<url type="homepage">https://github.com/pojntfx/vintangle</url>
<url type="bugtracker">https://github.com/pojntfx/vintangle/issues</url>
<url type="help">https://matrix.to/#/#vintangle:matrix.org?via=matrix.org</url>

<provides>
<binary>com.pojtinger.felicitas.vintangle</binary>
<binary>vintangle</binary>
</provides>

<releases>
Expand Down
Loading

0 comments on commit 7e6cef9

Please sign in to comment.