Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesohortle committed Sep 10, 2020
1 parent 04dd2ca commit 9a5fb41
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ unprintables = re.compile(r"[\u0000-\u001f]")

Or perhaps your coworkers don't have the necessary fonts to display glyphs and have used escapes so that their editors don't show them [_mojibake_](https://en.wikipedia.org/wiki/Mojibake) or � (`U+FFFD`).

Maybe your favourite language doesn't even support Unicode literals in source files after a certain version ([looking at you, Haskell](https://gitlab.haskell.org/ghc/ghc/-/issues/15525)) so you have to represent them with an escape.

In any case, it would be handy to immediately have information on the characters being processed instead of, e.g., going to an external website and searching for the codepoint.

## Usage/Features
Expand All @@ -31,15 +33,16 @@ Simply place your cursor over the escape sequence and a panel will hover over it
## Requirements

- Works on Python, JavaScript, TypeScript, TeX, LaTeX, Java, HTML, CSS and Haskell files.
- TeX files require [LaTeX Workshop](https://github.com/James-Yu/LaTeX-Workshop).
- Language support needs to be installed if it does not come default in VS Code.
- [LaTeX Workshop](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop)
- [Haskell for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=haskell.haskell)
- Needs a system font that defines a glyph for the character to be displayed.

## Known Issues

Pull requests (in particular for new languages) are welcome.

- Non-printable characters, by definition, do not normally have glyphs associated with them and so usually no glpyhs will be displayed. However, the description and link will still be shown. If a font somewhere on your system defines a glyph for a non-printable character, it will be displayed.
- [LaTeX Workshop](https://github.com/James-Yu/LaTeX-Workshop) is required for .tex files.

## Release Notes

Expand Down

0 comments on commit 9a5fb41

Please sign in to comment.