Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kimim committed Jan 11, 2025
1 parent c878590 commit a9eed8f
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
# Introduction

A small tool to various files to .svg files or download image files,
and insert it to orgmode or markdown on-the-fly.
A small tool converts various files to .svg files or downloads image
files, and inserts them to orgmode or markdown buffer on-the-fly.

**插 chā 图 tú**: insert a diagram.

See examples in [chatu.org](./chatu.org) and [chatu.md](./chatu.md).

# Install

Before using `chatu`, you may need to install some external programs and
set them in your PATH:
- draw.io and pdf2svg for drawio file conversion
- plantuml.jar, java for plantuml
- clojure for .clj script
- babashka for .bb script
- Python for .py script
- curl for downloading file from web
- R for statistic plotting
- lilypond for music notes

From melpa with use-package:
Add `chatu.el` from melpa with use-package:

```emacs-lisp
(use-package chatu
Expand Down

0 comments on commit a9eed8f

Please sign in to comment.