search

catppuccin / latex

✨ Soothing pastel theme for LaTeX
https://www.ctan.org/pkg/catppuccinpalette
MIT License
40 stars 2 forks source link

feat!: integrate existing `catppuccinPalette` into repository #5

Closed atticus-sullivan closed 1 month ago

atticus-sullivan commented 3 months ago

As discussed in #1 this is my upload of my .dtx file + necessary adjustments + add build.lua for easy building and packaging.

Still a Todo

atticus-sullivan commented 3 months ago

Ok, this is progressing. I already added an example for the github-action (not quite satisfied with the doubly-zipped artifact but I don't know of a nice way of resolving this).

So how do we proceed with the authors noted in the docs. Which ones should I add to the list and how should the by noted?

Also the README.md is still not updated and the current state of the package is not quite well tested (everyone is welcome to do so).

sgoudham commented 1 month ago

Hi @atticus-sullivan, so sorry about the wait on this - I completely forgot about this for a while until I checked all my GitHub notifications.

I already added an example for the github-action (not quite satisfied with the doubly-zipped artifact but I don't know of a nice way of resolving this).

Unfortunately this is just a GitHub Actions :tm: moment and there's not a way around it.

So how do we proceed with the authors noted in the docs. Which ones should I add to the list and how should the by noted?

I asked the original maintainer (@walshyb) how they felt about attribution and they were okay about not being included in the author list if all the files included were not their work. Of course, we will keep them in the README and list them as a past maintainer in the README if they are no longer interested in contributing / collaborating with yourself.

This is their full response from discord:

image

Also the README.md is still not updated and the current state of the package is not quite well tested (everyone is welcome to do so).

If you could update the instructions on the README on how to import the package manually, I'm happy to test it out.

Again, apologies for the wait on this and I hope you're still interested in contributing to this repository, thank you!

atticus-sullivan commented 1 month ago

Alright. Almost there, any idea how the assets (the images in the README.md) were generated? (while the colors are still the same, maybe we should just regenerate them just to be on the safe side).

Also please check if the Author information is fine now.

And at the moment the installation instruction refers to the artifact generated by the github action. Maybe making a release which directly contains the assets (not doubly zipped or so) and referencing that instead in the installation instructions would be nice. But we'd do that only after merging this PR right?

walshyb commented 1 month ago

@atticus-sullivan If I remember correctly, I converted each example PDF into an image (I think I turned them into webp?). I don't remember specifically how I did the pdf -> webp conversion.

Then I used Catppuccin's catwalk to combine the 4 images to generate the main README image

atticus-sullivan commented 1 month ago

Alright, thanks :+1: added a Makefile which automates (re)building the assets (based on the examples).

Assuming catwalk is installed of course

atticus-sullivan commented 1 month ago

Then I think this looks pretty finished from my side. Please be certain that the author information is correct / the way you want to.

And also the thing with creating a release (on github) would be still open. But I think that's more a thing for later.

atticus-sullivan commented 1 month ago

Also, have we discussed of or know of the process on how to "transfer" the package on CTAN to allow multiple maintainers (i.e. Catppuccin staff and yourself) to upload the package to CTAN?

I think I can just when uploading specify additional maintainers: image (I believe that's also possible when the upload is for an existing package and not a completely new one)

sgoudham commented 1 month ago

I think I can just when uploading specify additional maintainers:

Would this give the additional maintainer(s) the power to update the package too? e.g. could I under the catppuccin account upload a new version to CTAN? (if you specified that name in this list)

atticus-sullivan commented 1 month ago

tbh I'm not completely sure. But the only thing I found about this would indicate yes (the question would be how to properly reference you).

image (https://ctan.org/file/help/ctan/CTAN-upload-addendum)

Seems like the e-mail address plays a key role.

sgoudham commented 1 month ago

tbh I'm not completely sure. But the only thing I found about this would indicate yes (the question would be how to properly reference you).

I've just created the catppuccin account on CTAN, could you please add this account to the additional maintainers of the package?

image

atticus-sullivan commented 1 month ago

Alright, once merged I'll do the upload. There is also this field Administrative notes (to the CTAN maintainers) where I'll ask if the way we're/I'm doing this is correct and if that way you as the catppuccin orga will be able to submit updates in the end.

atticus-sullivan commented 1 month ago

You're welcome. I see you're already working on that release thing. Should I wait until you're finished with uploading to ctan?

sgoudham commented 1 month ago

I'm just about to head to bed haha. I'll create the workflow to automatically create GitHub releases based on commits to the main branch tomorrow.

I can see that the current version of the package is 1.0.2 on CTAN. Am I correct in saying that this PR is essentially equivalent to 1.0.2 on CTAN? If so, I can tag this commit (https://github.com/catppuccin/latex/commit/bcdc7a56af7c1b16576480f2c553f246c919b944) as 1.0.2 and this repository can continue with semver versioning as new features/fixes/breaking changes are merged @atticus-sullivan

To understand the workflow, I'd recommend reading the README of release-please. If you have a discord account, we can communicate much faster on the Catppuccin discord server if that's something you're interested in!

atticus-sullivan commented 1 month ago

Alright, I'll keep the webpage with the information filled in open for now then. (don't wonder though I might be hard to reach until the weekend)

No on CTAN is still the version from my other repository (not the fork of this one). Should be that version here Until now I just said 1.1.0 would be the version migrated to the catppuccin orga (noted so in the dtx). But we could change so (would need to do so before the upload though).