-
Notifications
You must be signed in to change notification settings - Fork 692
tud-letter:0.1.0 #3091
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
base: main
Are you sure you want to change the base?
tud-letter:0.1.0 #3091
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this package! I've left a few comments regarding the name, description, and the readme example.
@@ -0,0 +1,16 @@ | |||
[package] | |||
entrypoint = "src/lib.typ" | |||
name = "tud-letter" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you want this to be an official package, a faculty member needs to send an email to hello@typst.app endorsing this package. Otherwise the name needs to be prefixed by some non-descriptive part, so that multiple packages can co-exist. See our naming rules.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am actually a faculty member: https://www.tudelft.nl/staff/h.ledoux/ + https://3d.bk.tudelft.nl/hledoux but I don't think I have personally the authority to create an official template for my university... But then I don't think anyone at the central admin will do it either.
prefixing is surely simpler. Would "almost-tud-letter" be okay?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
almost-tud-letter
would work. I'm also not quite sure who has the authority to create official templates, if you figure that out we can always publish a new version of this package under the official name :)
compiler = "0.13.0" | ||
authors = ["Hugo Ledoux <@hugoledoux>"] | ||
repository = "https://github.com/hugoledoux/tudletter" | ||
description = "A Typst template that (almost?) replicates the TUDelft letter" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The word typst is somewhat redundant here and should be omitted. See: https://github.com/typst/packages/blob/main/docs/manifest.md#writing-a-good-description
## Example | ||
|
||
```typst | ||
#import "../src/lib.typ": * |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The example should use a package specification
#import "../src/lib.typ": * | |
#import "@preview/tud-letter:0.1.0": * |
I am submitting
A Typst template that (more or less) replicates the TUDelft letter, which is only available in Word...
I have read and followed the submission guidelines and, in particular, I
selected a name that isn't the most obvious or canonical name for what the package does
added a
typst.toml
file with all required keysadded a
README.md
with documentation for my packagehave chosen a license and added a
LICENSE
file or linked one in myREADME.md
tested my package locally on my system and it worked
[X ]
exclude
d PDFs or README images, if any, but not the LICENSEensured that my package is licensed such that users can use and distribute the contents of its template directory without restriction, after modifying them through normal use.