Skip to content

Commit 833f43a

Browse files
mpereiramacurovc
andauthored
Add use-package/quelpa install instructions (#1)
* Add use-package/quelpa install instructions Co-authored-by: Marco Vocialta <macurovc@tutanota.com>
1 parent 07b8703 commit 833f43a

1 file changed

Lines changed: 20 additions & 3 deletions

File tree

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,32 @@ def fetch_data(url: str, keys: List[int]) -> Mapping[int, str]:
2525

2626
The text gets automatically *indented* and *split* on multiple lines.
2727

28-
## Usage
28+
## Install
29+
30+
### With [use-package](https://github.com/jwiegley/use-package) and [quelpa](https://github.com/quelpa/quelpa)
31+
32+
```elisp
33+
(use-package insert-docstring
34+
:ensure nil
35+
:quelpa (insert-docstring
36+
:fetcher github
37+
:repo "macurovc/insert-docstring"))
38+
```
39+
40+
### Manually
2941

30-
Place [insert-docstring.el](insert-docstring.el) in your Emacs `load-path` and
31-
then set in the `~/.emacs` file a keybinding such as:
42+
Place [insert-docstring.el](insert-docstring.el) in your Emacs `load-path`. E.g.:
3243

3344
```elisp
3445
(add-to-list 'load-path (expand-file-name "~/{path/to}/insert-docstring"))
3546
(require 'insert-docstring)
47+
```
48+
49+
## Usage
3650

51+
Set in the `~/.emacs` file a keybinding such as:
52+
53+
```elisp
3754
(defun set-python-keybindings ()
3855
(local-set-key (kbd "C-c i") 'python-insert-google-docstring-at-point)
3956
)

0 commit comments

Comments
 (0)