emacs
/
plantuml-mode
mirror of https://github.com/skuro/plantuml-mode.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Clearer langauge

This commit is contained in:
Matt Trzcinski 2019-08-28 19:40:43 -04:00
parent e6ae2334ab
commit 18826f89a8
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -15,19 +15,29 @@ A [PlantUML](http://plantuml.sourceforge.net/) major mode for Emacs.
# Quick Guide # Quick Guide
1. Install with 1. Install with `M-x package-install<RET>`
2. Enable mode for current buffer `M-x plantuml-mode<RET>`
3. Write some PlantUML:
``` ```
M-x package-install<RET> @startuml
plantuml-mode<RET> Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: Another authentication Response
@enduml
``` ```
2. Preview diagrams with `C-c C-c` (`plantuml-preview`). 4. Preview diagrams with `C-c C-c` (`plantuml-preview`).
**WARNING:** This may send information to **WARNING:** This may send information to
`"https://www.plantuml.com/plantuml"`! Check that `plantuml-jar-path` `"https://www.plantuml.com/plantuml"`!
is correct for your use case and that `plantuml-default-exec-mode` is
set to `jar` before previewing any sensitive material. See [Execution modes](# Execution modes) for more information. Check that `plantuml-jar-path` is correct for your use case and that
`plantuml-default-exec-mode` is set to `jar` before previewing any
sensitive material. See [Execution modes](# Execution modes) for more
information.
```lisp ```lisp
(setq plantuml-jar-path "/path/to/your/copy/of/plantuml.jar") (setq plantuml-jar-path "/path/to/your/copy/of/plantuml.jar")