Conversation
Added a comprehensive README for the Typst template, detailing features, usage instructions, project structure, configuration, citation style, contribution guidelines, and licensing.
…w/strangelion/0.1.0/resource/logo.png
…ackages/preview/strangelion/thumbnail.png
| @@ -0,0 +1,143 @@ | |||
| set text(lang: "zh", region: "cn") | |||
| @@ -0,0 +1,66 @@ | |||
| # 大学论文 Typst 模板 | |||
|
|
|||
| 一个为本科生毕业论文设计的 Typst 排版模板。它基于中文学术规范,帮助使用者快速完成论文的封面、章节和参考文献排版,让使用者专注于写作本身。 | |||
There was a problem hiding this comment.
It is generally appreciated to have at least one sentence in your README (and the description field in the package manifest) in English, to give a bit of context about the package to the broader Typst community, even if the target audience for that package is Chinese speaking.
| // 指导教师 | ||
| supervisor: "罗教授", | ||
| // 日期(自动生成当前年份) | ||
| date: datetime.today().display("[year]年[month]月[day]日"), |
There was a problem hiding this comment.
There is a control character here (shown as ^M at the end of the line), you probably want to remove it.
There was a problem hiding this comment.
Can you please check that you are allowed to distribute this logo? And if so, can you specify under which terms it can be used (in your README for example)?
There was a problem hiding this comment.
I think this file should go in a dedicated sub-directory, and be marked as a template entrypoint in your typst.toml.
| @@ -0,0 +1,53 @@ | |||
| #import "@preview/strangelion:0.1.0/template.typ": template | |||
There was a problem hiding this comment.
This import syntax is not valid, it should either be the package "specification" (i.e. @preview/strangelion:0.1.0) in which case it will import the entrypoint (here template.typ), or the relative path of the file, in case the file is to be edited by the user and included in their own project.
So here, I would say the first import should be a package specification, and the second just config.typ.
I am submitting
Description: Explain what the package does and why it's useful.
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.mdexcluded PDFs or README images, if any, but not the LICENSE