diff --git a/README.md b/README.md index fb37e90..051c06f 100644 --- a/README.md +++ b/README.md @@ -32,15 +32,18 @@ Alice <-- Bob: Another authentication Response 4. Preview diagrams with `C-c C-c` (`plantuml-preview`). **WARNING:** This may send information to -`"https://www.plantuml.com/plantuml"`! - -Before previewing any sensitive material, check that -`plantuml-jar-path` is correct for your use case and that -`plantuml-default-exec-mode` is set to `jar`. +`"https://www.plantuml.com/plantuml"`! Check that +`plantuml-default-exec-mode` is configured correctly for your use case +before previewing any sensitive material. ```lisp - (setq plantuml-jar-path "/path/to/your/copy/of/plantuml.jar") - (setq plantuml-default-exec-mode 'jar) + ;; Sample jar configuration + (setq plantuml-jar-path "/path/to/your/copy/of/plantuml.jar") + (setq plantuml-default-exec-mode 'jar) + + ;; Sample executable configuration + (setq plantuml-executable-path "/path/to/your/copy/of/plantuml.bin") + (setq plantuml-default-exec-mode 'executable) ``` See [Execution modes](#execution-modes) for more information. @@ -49,17 +52,17 @@ See [Execution modes](#execution-modes) for more information. Make sure you have [MELPA](http://melpa.org/) enabled in your ``emacs.d``. Then, you can just - M-x package-install - plantuml-mode + M-x package-install + plantuml-mode Also, to enable preview you need to tell `plantuml-mode` where to locate the PlantUML JAR file. By default it will look for it in `~/plantuml.jar`, but you can specify any location with: - M-x customize-variable - plantuml-jar-path + M-x customize-variable + plantuml-jar-path You can also download the latest version of PlantUML straight into `plantuml-jar-path`: - M-x plantuml-download-jar + M-x plantuml-download-jar # Features @@ -72,8 +75,8 @@ You can also download the latest version of PlantUML straight into `plantuml-jar You can automatically enable `plantuml-mode` for files with extension `.plantuml` by adding the following to your `.emacsrc`: - ;; Enable plantuml-mode for PlantUML files - (add-to-list 'auto-mode-alist '("\\.plantuml\\'" . plantuml-mode)) + ;; Enable plantuml-mode for PlantUML files + (add-to-list 'auto-mode-alist '("\\.plantuml\\'" . plantuml-mode)) Of course, you can always enable manually the major mode by typing `M-x plantuml-mode` once in the desired PlantUML file buffer. @@ -95,11 +98,11 @@ If you want to force a specific output format, you can customize the variable `p The following shortcuts are enabled by default: - C-c C-c plantuml-preview: renders a PlantUML diagram from the current buffer in the best supported format + C-c C-c plantuml-preview: renders a PlantUML diagram from the current buffer in the best supported format - C-u C-c C-c plantuml-preview in other window + C-u C-c C-c plantuml-preview in other window - C-u C-u C-c C-c plantuml-preview in other frame + C-u C-u C-c C-c plantuml-preview in other frame ## Integration with `org-mode`