TiddlyWiki / TiddlyDesktop

A custom desktop browser for TiddlyWiki 5 and TiddlyWiki Classic, based on nw.js
1.69k stars 124 forks source link

Adding this to flathub #283

Open ahzay opened 1 year ago

ahzay commented 1 year ago

Hi,

I wrote a flatpak manifest json and I wanted to add it to flathub, however their documentation specifies that it is best to get in touch with the app developer so that they are in charge of it. If you are ok with it I'd like to add it in a pr, would it just be the required files in a directory at the root of the project of this repo which is also published on flathub? I'm new to contributing.

Thank you.

Jermolene commented 1 year ago

Hi @ahzay and welcome to the project

I wrote a flatpak manifest json and I wanted to add it to flathub, however their documentation specifies that it is best to get in touch with the app developer so that they are in charge of it.

That's great, thank you, I'm sure it would be helpful for a lot of users to get TiddlyDesktop onto Flathub.

If you are ok with it I'd like to add it in a pr, would it just be the required files in a directory at the root of the project of this repo which is also published on flathub? I'm new to contributing.

It depends how many files need adding. The cleanest option would be to just add a dotfile in the root of the repo. If there are more than a couple of files then a subdirectory makes sense.

ahzay commented 1 year ago

Hello, @Jermolene

It depends how many files need adding. The cleanest option would be to just add a dotfile in the root of the repo. If there are more than a couple of files then a subdirectory makes sense.

It's only two files, the JSON and the .desktop, I can also include a third one for building instructions. By dotfile do you mean a hidden folder?

Jermolene commented 1 year ago

Thanks @ahzay I think perhaps it makes sense to put the files in a subdirectory. Is there an established subfolder that tools expect to find these files like .flatpak? (I am not familiar with Flatpak I'm afraid).

Should I also register a TiddlyWiki account with Flathub to own the listing?

ahzay commented 1 year ago

@Jermolene I just realized that displaying inline images is broken in the flatpak, it only shows the small picture icon could be a dependency issue. I will try to fix this weekend and then report back.

Should I also register a TiddlyWiki account with Flathub to own the listing?

According to this to submit a listing you just make a pr. I guess there's no real need to include it in this repo, I can just give it to you once it's fixed. If you allow me to make the pr over there myself I wouldn't mind either, it's kind of a weird process they have of asking you to outright tell the maintainer of the application to also maintain a flatpak for it 😅.