Skip to content

Commit c51f327

Browse files
committed
feat: Update README with test commands and license info
1 parent e1c5082 commit c51f327

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
<div align="center">Version 0.1.0</div>
33

44
Template for a two column article layout for the [Coders' Compass website](https://coderscompass.org). It allows users to write articles in markdown or Typst, which can then be rendered to a PDF suitable for print.
5+
56
Uses Coders' Compass branding and styling.
67

78
## Template adaptation checklist
@@ -89,5 +90,16 @@ typst c template/main.typ --format=png assets/images/page-{p}.png
8990
typst c template/main.typ --format=svg assets/images/page-{p}.svg
9091

9192
# Running tests with tytanic
92-
93+
tt run
94+
tt run test1
95+
tt run unit1
9396
```
97+
98+
Remember to copy any changes to `template/main.typ` to the test case in `tests/test1/test.typ`. Also ensure that the contents file is copied over.
99+
100+
## License
101+
102+
This project is **partially** licensed under the [MIT License](LICENSE). This includes all code files and the documentation (manual).
103+
Only exception: the Coders' Compass branding assets, specifically the [logo](assets/images/cc-icon.png).
104+
105+
All rights reserved to Coders' Compass for the branding assets (logo).

0 commit comments

Comments
 (0)