From be8e208f078b0b5caac7ca4f673f1ee64916c28b Mon Sep 17 00:00:00 2001 From: Andrew Helwer <2n8rn1w1f@mozmail.com> Date: Fri, 17 May 2024 12:39:43 -0400 Subject: [PATCH] Updated README to reflect TLC Unicode changes Signed-off-by: Andrew Helwer <2n8rn1w1f@mozmail.com> --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3084581..6d62b71 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,11 @@ It consists of two crates: a library exposing this functionality (using [tree-si Use this tool to: * Create a nice-looking copy of your spec that is pleasant to read but can still be edited and meaningfully tracked by source control -* Confidently write specs in Unicode with the [tlaplus-nvim-plugin](https://github.com/tlaplus-community/tlaplus-nvim-plugin) then output their ASCII equivalent to a temporary file for use with SANY and TLC -* Convert your existing ASCII specs to Unicode and use them with Unicode-aware tooling like [tla-web](https://github.com/will62794/tla-web) +* Convert your existing ASCII specs to Unicode and use them with Unicode-aware tooling like [tla-web](https://github.com/will62794/tla-web) or TLC +* Confidently write specs in Unicode with the [tlaplus-nvim-plugin](https://github.com/tlaplus-community/tlaplus-nvim-plugin) then output their ASCII equivalent to a temporary file for use with legacy non-Unicode-aware tooling Note that GitHub itself uses the tree-sitter-tlaplus grammar for highlighting, so it supports Unicode TLA⁺ as shown in the highlighted code snippets here. -If you want to check Unicode specs into source control and run non-Unicode-aware tooling like TLC during your CI process, you can add a step using this tool to translate your Unicode spec into TLC-supported form. +SANY and TLC also now both support Unicode. The symbol mapping can be found in the [`./resources/tla-unicode.csv`](./resources/tla-unicode.csv) file, taken from the [tlaplus-standard](https://github.com/tlaplus-community/tlaplus-standard) repo. The crate also provides programmatic access to these mappings.