Skip to content

Commit 30b10be

Browse files
T0mstoneknuesel
andcommitted
Add explanation of terms
Co-authored-by: Jeremie Knuesel <knuesel@gmail.com>
1 parent 0a8c1a2 commit 30b10be

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,27 @@
11
# Contributing Guidelines
22
Contributions are welcome! This document provides some resources and guidelines to help with the process.
33

4-
Symbol definitions are in `src/modules/`; The syntax should be mostly self-evident.
5-
If you need help with a contribution, you can ask us [on Discord](https://discord.com/channels/1054443721975922748/1277628305142452306).
4+
Codex collects related Unicode symbols as different *variants* of the same *symbol*.[^symbol]
5+
For example, `→ ⇒ ↑ ⇑` are four variants of the `arrow` symbol.
6+
Each symbol has a default variant (here ``).
7+
To refer to a particular variant, *modifiers* can be appended to the symbol name
8+
using dot separators.
9+
For example `` is `arrow.double`, `` is `arrow.t` and `` is `arrow.double.t`.
10+
Modifiers are order-independent, so the latter can also be referred to as `arrow.t.double`.
11+
Groups of related symbols are collected into *modules*. Modules can also contain other modules.
12+
Codex exports two main modules: `sym` for for text-style symbols and `emoji` for emoji;
13+
Their source code is found in `src/modules/`.
14+
15+
If you need help with a contribution, you can also ask us [on Discord](https://discord.com/channels/1054443721975922748/1277628305142452306).
616

717
Proposals used to be written in a dedicated Proposals document,
818
but new proposals should now be filed as GitHub issues instead.
919
The [document](https://typst.app/project/riXtMSim5zLCo7DWngIFbT)
1020
has been repurposed to serve as a collection of useful information
1121
and naming ideas.
1222

23+
[^symbol]: This document also uses "symbol" in the more abstract sense of a graphical symbol.
24+
1325
## Conventions
1426
When adding new modules, symbols or variants, please try to be consistent with
1527
existing ones. Below are some guidelines based on existing symbols. These aren't

0 commit comments

Comments
 (0)