mirror of
https://github.com/ascii-boxes/boxes.git
synced 2025-03-01 15:51:20 +01:00
Updated the Emacs editor integration instructions.
● Added instructions for installing the `boxes` Emacs package from MELPA. ● Updated the manual installation instructions.
This commit is contained in:
parent
1c128fb530
commit
bd1711aa24
@ -2,7 +2,7 @@
|
||||
title: Editor Integration - Emacs
|
||||
permalink: editors-emacs.html
|
||||
created_at: 1999-04-06
|
||||
last_modified_at: 2014-12-23 22:50:00 +0100
|
||||
last_modified_at: 2022-12-12 17:34:00 +0000
|
||||
---
|
||||
|
||||
<a href="{{ site.baseurl }}/editors.html"><button type="button" class="btn btn-outline-primary">Back to All Editors</button></a>
|
||||
@ -10,21 +10,56 @@ last_modified_at: 2014-12-23 22:50:00 +0100
|
||||
|
||||
# Integration with Emacs
|
||||
|
||||
<span class="atmention">[@zerotao](https://github.com/zerotao)</span> kindly provided the following information on
|
||||
integrating *boxes* with Emacs:
|
||||
[](https://melpa.org/#/boxes)
|
||||
|
||||
The simple interface (only a single box style, but easy):
|
||||
The easiest way is to install the `boxes` package from [MELPA](https://melpa.org/#/boxes), however it can also be installed manually if desired:
|
||||
|
||||
```lisp
|
||||
(defun boxes-create ()
|
||||
(interactive)
|
||||
(shell-command-on-region (region-beginning) (region-end) "boxes -d c-cmt2" nil 1 nil))
|
||||
- Installation from MELPA
|
||||
1. Make sure [MELPA is in your package archives list](https://melpa.org/#/getting-started).
|
||||
|
||||
2. `M-x package-install boxes`
|
||||
|
||||
(defun boxes-remove ()
|
||||
(interactive)
|
||||
(shell-command-on-region (region-beginning) (region-end) "boxes -r -d c-cmt2" nil 1 nil))
|
||||
```
|
||||
3. Add key bindings for the `boxes` commands to your startup file:
|
||||
|
||||
<span class="atmention">[@zerotao](https://github.com/zerotao)</span> also wrote a
|
||||
[*boxes* mode for Emacs](https://github.com/{{ site.github }}/blob/master/doc/boxes.el). Remember to update its design
|
||||
list when you add new designs to your config file.
|
||||
```emacs-lisp
|
||||
(global-set-key "\C-cb" 'boxes-command-on-region)
|
||||
(global-set-key "\C-cq" 'boxes-create)
|
||||
(global-set-key "\C-cr" 'boxes-remove)
|
||||
```
|
||||
|
||||
4. Alternatively, if `use-package` is installed you can automatically install the `boxes` binary & elisp packages and
|
||||
add the key bindings with the following form, just like magic 😊
|
||||
|
||||
```emacs-lisp
|
||||
(use-package boxes
|
||||
:ensure t
|
||||
:ensure-system-package boxes
|
||||
:bind (("C-c b" . boxes-command-on-region)
|
||||
("C-c q" . boxes-create)
|
||||
("C-c r" . boxes-remove)))
|
||||
```
|
||||
|
||||
- Manual Installation
|
||||
1. [Download](https://github.com/{{ site.github }}/blob/master/doc/boxes.el) `boxes.el` to a directory and add it
|
||||
to your `load-path`:
|
||||
|
||||
```emacs-lisp
|
||||
(add-to-list 'load-path <install directory>)
|
||||
```
|
||||
|
||||
2. Add autoloads to your startup file so `boxes` will be loaded on first use:
|
||||
|
||||
```emacs-lisp
|
||||
(autoload 'boxes-command-on-region "boxes" nil t)
|
||||
(autoload 'boxes-remove "boxes" nil t)
|
||||
(autoload 'boxes-create "boxes" nil t)
|
||||
```
|
||||
|
||||
3. Add key bindings for the `boxes` commands to your startup file:
|
||||
|
||||
```emacs-lisp
|
||||
(global-set-key "\C-cb" 'boxes-command-on-region)
|
||||
(global-set-key "\C-cq" 'boxes-create)
|
||||
(global-set-key "\C-cr" 'boxes-remove)
|
||||
```
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user