-
Notifications
You must be signed in to change notification settings - Fork 885
touying-buaa-theme:0.1.0 #3909
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?
touying-buaa-theme:0.1.0 #3909
Conversation
elegaanz
left a comment
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 building this package. I have some remarks to share, but once they are addressed it will be published.
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.
Can you please add a note in your README (or some other file) to specify under which conditions these files are distributed and may be used (unless they are under the exact same license as the rest of the package, but I doubt they are)?
| @@ -0,0 +1,149 @@ | |||
| # BUAA-slide-typst | |||
| 一个基于[touying](https://github.com/touying-typ/touying)开发的BUAA[typst](https://github.com/typst/typst)模板. | |||
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.
It would be appreciated if you could write at least one sentence in English at the beginning of your README to give a bit of context about this template to the broader Typst community, even if your target audience is Chinese-speaking.
| ## 快速开始 | ||
| 创建一个typst文件, 在文件开头使用`#import "@preview/BUAA-Slide:0.1.0": *`导入该模板. 使用`#show: buaa-theme.with()`设置基本信息与初始化幻灯片. | ||
| ```typst | ||
| #import "@preview/BUAA-Slide:0.1.0": * |
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 think package imports are case sensitive.
| @@ -0,0 +1,16 @@ | |||
| [package] | |||
| name = "buaa-slide" | |||
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.
Because this is not an official package of the University, can you pick another name please? It should be distinctive enough so that another package with the same purpose can be published without one of the two having an unfair advantage, and it should be clear from the name that it is community-built and not officially endorsed by the university.
If you want to make this template official to keep the current name, that's also an option. In that case a member of the University staff should send an email to hello@typst.app stating that they officially endorse your package. In practice it means that they will accept submission of works built using it, and ideally promote it and guarantee that it will be maintained on the long term.
| repository = "https://github.com/Lyrics2196/BUAA-Slide" | ||
| keywords = ["slides", "BUAA", "touying", "presentation", "lecture"] | ||
| categories = ["presentation"] | ||
| compiler = "0.14.2" |
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.
This version number corresponds to the oldest compiler version you support. Unless you need a fix that was introduced in 0.14.2, it should be lower (0.14.0 or even less than that).
…se used in the readme file.
Thank you for your review. All the suggestions you have made have been addressed as follows:
|
I am submitting
Description: A beautiful and easy-to-use Beihang University slide template based on touying.
I have read and followed the submission guidelines and, in particular, I
typst.tomlfile with all required keysREADME.mdwith documentation for my packageLICENSEfile or linked one in myREADME.mdexcludedPDFs or README images, if any, but not the LICENSE