Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
terasakisatoshi committed Dec 22, 2024
1 parent 8aafa15 commit 7753fa4
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
# DocstringAsImage.jl

This package visualizes Julia docstrings for functions with images.
[![CI](https://github.com/AtelierArith/DocstringAsImage.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/AtelierArith/DocstringAsImage.jl/actions/workflows/CI.yml)

This package allows us to visualize Julia docstrings as images. This feature works only in terminals that support Sixel Graphics. Internally we use Quarto and Typst to render images. We use Sixel.jl package to render generated images in your terminal.

## Setup

```
julia> using Pkg; Pkg.add("DocstringAsImage")
```

To build from source, run the following commands:

```sh
$ git clone https://github.com/AtelierArith/DocstringAsImage.jl.git
$ cd DocstringAsImage.jl
Expand All @@ -14,6 +22,8 @@ Manifest.toml Project.toml README.md src

## Usage

Our package exports `@imgdoc` macro. It works like the `@doc` macro.

```julia
$ julia
_
Expand Down

0 comments on commit 7753fa4

Please sign in to comment.