diff options
| author | hachem <im@hachem.wtf> | 2026-09-18 19:41:32 +0200 |
|---|---|---|
| committer | hachem <im@hachem.wtf> | 2026-09-18 19:41:32 +0200 |
| commit | 3131b944331278534e299361c7619e4fe3e43cd4 (patch) | |
| tree | bc431c6fa0def5bdd17e5e548dd400ddbdeeaf40 | |
| parent | 8075871a5b364d41f59a8153bb632cd9c893f895 (diff) | |
chore: update README
| -rw-r--r-- | README.md | 20 |
1 files changed, 10 insertions, 10 deletions
@@ -1,16 +1,16 @@ # mktypst -Just a couple of dumb Typst templates so I stop rewriting the same document setup every fucking time. +just a couple of dumb typst templates so i stop rewriting the same document setup every fucking time. ```sh $ mktypst rapport $ typst watch rapport.typ ``` -## Templates -`paper` is a two-column academic article; `letter` is a French formal letter. Both are French by default (`lang: "fr"`), so you get guillemets, the spacing before `; : ! ?`, `Résumé`, `Tableau`, all of it — pass `lang: "en"` for English. +## templates +`paper` is a two-column academic article; `letter` is a french formal letter. both are french by default (`lang: "fr"`), so you get guillemets, the spacing before `; : ! ?`, `Résumé`, `Tableau`, all of it — pass `lang: "en"` for english. -You apply one with a `#show` rule at the top of the document and start writing: +you apply one with a `#show` rule at the top of the document and start writing: ```typ #import "@local/hachem:0.1.0": paper @@ -26,9 +26,9 @@ You apply one with a `#show` rule at the top of the document and start writing: Du texte. ``` -The `letter` works the same way. There are full examples in `samples/`, and `make samples` compiles them. +the `letter` works the same way. there are full examples in `samples/`, and `make samples` compiles them. -## Usage +## usage ```text $ mktypst --help @@ -59,7 +59,7 @@ $ mktypst -t letter -T "candidature" x # a letter instead $ mktypst --stdout note # print it, don't write a file ``` -## Install +## install ```sh $ git clone https://git.hachem.wtf/mktypst && cd mktypst @@ -67,8 +67,8 @@ $ sudo make install # mktypst -> /usr/local/bin, templates -> @local/ $ make install PREFIX=~/.local # or without sudo ``` -You need a C compiler for the binary, and Typst (plus the EB Garamond font) to build documents. The templates install into Typst's local package dir, so any file can `#import "@local/hachem:0.1.0"`. In the Typst app, link that folder as the namespace `local` and it works there too. +you need a c compiler for the binary, and typst (plus the eb garamond font) to build documents. the templates install into typst's local package dir, so any file can `#import "@local/hachem:0.1.0"`. in the typst app, link that folder as the namespace `local` and it works there too. -## License +## license -`mktypst` is licensed under the MIT License. See [LICENSE](LICENSE) for more. +`mktypst` is licensed under the mit license. see [license](LICENSE) for more. |