Skip to content

Commit 5dd5b24

Browse files
committed
update latexify equation
1 parent 001c0b5 commit 5dd5b24

File tree

1 file changed

+25
-26
lines changed

1 file changed

+25
-26
lines changed

README.md

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
[![][pkgeval-img]][pkgeval-url]
55
[![][codecov-img]][codecov-url]
66

7-
ImageInTerminal.jl is a drop-in package that once imported
8-
changes a how a single `Colorant` and whole `Colorant` arrays (i.e.
9-
Images) are displayed in the interactive REPL.
7+
`ImageInTerminal` is a drop-in package that once imported changes
8+
how a single `Colorant` and whole `Colorant` arrays (regular images)
9+
are displayed in the interactive REPL.
1010
The displayed images will be downscaled to fit into the size of
1111
your active terminal session.
1212

1313
To activate this package simply import it into your Julia session.
1414

15-
### Without this package
15+
### Without ImageInTerminal
1616

1717
```julia
1818
julia> using Images, TestImages
@@ -45,7 +45,7 @@ julia> colorview(RGB, rand(3, 10, 10))
4545
RGB{Float64}(0.422224,0.914328,0.773111) RGB{Float64}(0.448258,0.955572,0.0445449)
4646
```
4747

48-
### With this package
48+
### Using ImageInTerminal
4949

5050
```julia
5151
julia> using Images, TestImages, ImageInTerminal
@@ -59,8 +59,8 @@ julia> colorview(RGB, rand(3, 10, 10))
5959

6060
### Sixel encoder (Julia 1.6+)
6161

62-
If [`Sixel`](https://github.com/johnnychen94/Sixel.jl) (requires Julia 1.6+) is loaded, this package will try to encode
63-
the content using `Sixel` encoder for large images, and thus bring much better image visualization experience in terminal:
62+
If [`Sixel`](https://github.com/johnnychen94/Sixel.jl) is supported by the terminal, this package will encode
63+
the content using a `Sixel` encoder for large images, and thus bring much better image visualization experience in terminal:
6464

6565
<img src="https://github.com/JuliaImages/ImageInTerminal.jl/raw/imgs/sixel.png" alt="Sixel" width="500">
6666

@@ -74,45 +74,44 @@ See [Terminals that support sixel](https://github.com/johnnychen94/Sixel.jl#term
7474
```julia
7575
using ImageInTerminal, Latexify
7676

77-
render(latexify(:(x / y)), MIME("image/png"))
77+
render(latexify(:(* (∂Ψ(𝐫, t) / ∂t) = -ħ^2 / 2m * ΔΨ(𝐫, t) + V * Ψ(𝐫, t))), MIME("image/png"))
7878
```
7979

80-
<img src="https://github.com/JuliaImages/ImageInTerminal.jl/raw/imgs/latexify.png" alt="Latexify" width="300">
80+
<img src="https://github.com/JuliaImages/ImageInTerminal.jl/raw/imgs/latexify.png" alt="Latexify" width="500">
8181

8282
### 8-bit (256) colors and 24-bit colors
8383

84-
By default this packages will detect if your running terminal supports 24 bit colors, i.e., true color.
85-
If it does, then the image will be displayed in 24-bit colors,
86-
otherwise it will use 256 colors (8-bit) as a fallback option.
87-
To manually switch between 24-bit colors and 256 colors, you can use the internal helpers:
84+
By default this packages will detect if your running terminal supports 24-bit colors (true colors).
85+
If it does, the image will be displayed in 24-bit colors, otherwise it fallbacks to 8-bit (256 colors).
86+
To manually switch between 24-bit and 8-bit colors, you can use the internal helpers:
8887

8988
```julia
90-
using XTermColors
91-
XTermColors.set_colormode(8)
92-
XTermColors.set_colormode(24)
89+
using ImageInTerminal
90+
ImageInTerminal.set_colormode(8)
91+
ImageInTerminal.set_colormode(24)
9392
```
9493

9594
Note that 24 bits format only works as expected if your terminal supports it,
96-
otherwise you are likely to get some random outputs. To check if your terminal
97-
supports 24 bits color, you can check if the environment variable `COLORTERM` is
98-
`24bit` (or `truecolor`).
95+
otherwise you are likely to get some random outputs.
96+
To check if your terminal supports 24 bits color, you can check if
97+
the environment variable `COLORTERM` is set to `24bit` (or `truecolor`).
9998

10099
Here's how images are displayed in 24-bit colors:
101100

102101
<img src="https://github.com/JuliaImages/ImageInTerminal.jl/raw/imgs/cameraman.png" alt="Cameraman" width="500">
103102

104103
### Enable and disable
105104

106-
If you want to temporarily disable this package, you can call `ImageInTerminal.disable_encoding()`. To
107-
restore the encoding functionality with `ImageInTerminal.enable_encoding()`.
105+
If you want to temporarily disable this package, you can call `ImageInTerminal.disable_encoding()`.
106+
To restore the encoding functionality use `ImageInTerminal.enable_encoding()`.
108107

109108
## Troubleshooting
110109

111-
If you see out of place horizontal lines in your Image it means
112-
that your font displays the utilized unicode block-characters
113-
in an unfortunate way. Try changing font or reducing your
114-
terminal's line-spacing. If your font is Source Code Pro, update to
115-
the latest version.
110+
If you see out of place horizontal lines in your Image it means that
111+
your font displays the unicode block-characters in an unfortunate way.
112+
Try changing font or reducing your terminal's line-spacing.
113+
If your font is Source Code Pro, update to the latest version.
114+
It is recommended to use the [JuliaMono](https://juliamono.netlify.app) font.
116115

117116
<!-- URLS -->
118117

0 commit comments

Comments
 (0)