Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sitelen-pona package #113

Merged
merged 5 commits into from
May 8, 2024
Merged

Add sitelen-pona package #113

merged 5 commits into from
May 8, 2024

Conversation

neroist
Copy link
Contributor

@neroist neroist commented May 6, 2024

Added package for typing sitelen pona (toki pona's main writing system) via UCSUR.

If you're wondering, the language at the end of the readme is toki pona, and what I wrote translates to about:

Using this tool, you can write sitelen pona with Espanso. Communicate/talk well and write well!

Copy link
Collaborator

@smeech smeech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simple text replacement package. As it uses a lot of common single-character triggers without prefix or suffix, it won't be for everybody, but I can see it might fit within an app-specific config.
A lot of characters not readable on GitHub, but I fed package.yml to https://www.kreativekorp.com/software/fonts/sitelenselikiwen/ to see how they appear.
No cmd, shell, script or apparently risky code.
The README.md could be more helpful.
Needs some tags and could safely be merged.

title: "o sitelen pona!"
description: A package for writing UCSUR sitelen pona with Espanso!
version: 0.1.0
author: niko
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs some tags:. See espanso hub for examples.

@neroist
Copy link
Contributor Author

neroist commented May 7, 2024

Thank you for the review! I'll make some changes

@smeech
Copy link
Collaborator

smeech commented May 7, 2024

Thank you. Just awaiting someone else to review the package and I think i can be merged.

Copy link
Contributor

@rbstrachan rbstrachan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think the README is a problem given that anyone who would want to use this package will already be familiar with Toki Pona.

The changes look good to me!

@smeech
Copy link
Collaborator

smeech commented May 7, 2024

That took me down a rabbit hole - via a YouTube video, and onto the ma pona pi toki pona Discord server, with several mentions of Espanso!

@smeech
Copy link
Collaborator

smeech commented May 7, 2024

I don't think the README is a problem given that anyone who would want to use this package will already be familiar with Toki Pona.

The changes look good to me!

Yes, it was a minor point.

@neroist
Copy link
Contributor Author

neroist commented May 7, 2024

Regarding the readme, I think it would be helpful to list how many and what words are supported by the package, as well as how to use it (as it doesn't use any prefix or suffix, but is intended to be used with Espanso's toggle key feature).

@smeech
Copy link
Collaborator

smeech commented May 8, 2024

The tags I was thinking of included "symbols", "languages", "letters", "writing", "characters", "communication" etc..
They'd place the package in those filtered lists in https://hub.espanso.org/search, and make it easier for interested users to find.
I'll leave it to @neroist to choose some or all.

Having taken a trip down the rabbit hole! the README.md could interest people browsing the packages and encourage them to take the same journey. I can see there is an expanding toki pona community. You don't need to go as far as the one for github-emojis-latest!

@AucaCoyan
Copy link
Member

Looks goods! Thank you guys for reviewing and the rapid response of the dev.
Does this need any further changes or can it be merged?

@smeech
Copy link
Collaborator

smeech commented May 8, 2024

I think adding the tags I suggested would be helpful to hub users. We could do that, but yes.

@neroist
Copy link
Contributor Author

neroist commented May 8, 2024

I added the tags :) I think I'll write a README.tok.md and I'll be done (or can there only be one readme?)

@smeech smeech merged commit 8c3a59c into espanso:main May 8, 2024
1 check passed
@AucaCoyan
Copy link
Member

It's a valid question, in the instant I was writing this comment smeech merged it 💯
We can test having 2 readmes with this pkg. Could you submit another PR adding a readme to this package? no need to add a new version.
We merge it and then we check the website and if it works as expected

@smeech
Copy link
Collaborator

smeech commented May 8, 2024

I've merged the package.
I think there should only be one README.md.
If you want to update it, we can pull it in quite quickly.
I'm not sure how long it takes for Espanso Hub to pick up the changes,

@smeech
Copy link
Collaborator

smeech commented May 8, 2024

The Hub website uses README.md, so I think we should stick to one file.

@smeech
Copy link
Collaborator

smeech commented May 8, 2024

It's in: https://hub.espanso.org/sitelen-pona

@AucaCoyan
Copy link
Member

Yeah, on the webpage it will load only one readme, but I'm wondering if you donwload the package with espanso install sitelen-pona, does that download the two readmes? it should

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants