Skip to content

Commit 789e259

Browse files
committed
chore: Update version to 0.1.1 and remove template checklist from README
1 parent d453489 commit 789e259

File tree

1 file changed

+1
-21
lines changed

1 file changed

+1
-21
lines changed

README.md

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,10 @@
11
# The `articulate-coderscompass` Package
2-
<div align="center">Version 0.1.0</div>
2+
<div align="center">Version 0.1.1</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.
55

66
Uses Coders' Compass branding and styling.
77

8-
## Template adaptation checklist
9-
10-
- [ ] Fill out `README.md`
11-
- Change the `my-package` package name, including code snippets
12-
- Check section contents and/or delete sections that don't apply
13-
- [x] Check and/or replace `LICENSE` by something that suits your needs
14-
- [x] Fill out `typst.toml`
15-
- See also the [typst/packages README](https://github.com/typst/packages/?tab=readme-ov-file#package-format)
16-
- [ ] Adapt or deactivate the release workflow in `.github/workflows/release.yml`
17-
- to deactivate it, delete that file or remove/comment out lines 2-4 (`on:` and following)
18-
- to use the workflow
19-
- [ ] check the values under `env:`, particularly `REGISTRY_REPO`
20-
- [ ] if you don't have one, [create a fine-grained personal access token](https://github.com/settings/tokens?type=beta) with [only Contents permission](https://stackoverflow.com/a/75116350/371191) for the `REGISTRY_REPO`
21-
- [ ] on this repo, create a secret `REGISTRY_TOKEN` (at `https://github.com/[user]/[repo]/settings/secrets/actions`) that contains the so created token
22-
23-
if configured correctly, whenever you create a tag `v...`, your package will be pushed onto a branch on the `REGISTRY_REPO`, from which you can then create a pull request against [typst/packages](https://github.com/typst/packages/)
24-
- [ ] remove/replace the example test case
25-
- [ ] (add your actual code, docs and tests)
26-
- [ ] remove this section from the README
27-
288
## Getting Started
299

3010
1. Start with the [main.typ](template/main.typ) file which imports the `articulate-coderscompass` package and demonstrates its usage.

0 commit comments

Comments
 (0)