Skip to content

Commit

Permalink
Add use-package/quelpa install instructions (#1)
Browse files Browse the repository at this point in the history
* Add use-package/quelpa install instructions

Co-authored-by: Marco Vocialta <macurovc@tutanota.com>
  • Loading branch information
mpereira and macurovc authored Oct 6, 2021
1 parent 07b8703 commit 833f43a
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,32 @@ def fetch_data(url: str, keys: List[int]) -> Mapping[int, str]:

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

## Usage
## Install

### With [use-package](https://github.com/jwiegley/use-package) and [quelpa](https://github.com/quelpa/quelpa)

```elisp
(use-package insert-docstring
:ensure nil
:quelpa (insert-docstring
:fetcher github
:repo "macurovc/insert-docstring"))
```

### Manually

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

```elisp
(add-to-list 'load-path (expand-file-name "~/{path/to}/insert-docstring"))
(require 'insert-docstring)
```

## Usage

Set in the `~/.emacs` file a keybinding such as:

```elisp
(defun set-python-keybindings ()
(local-set-key (kbd "C-c i") 'python-insert-google-docstring-at-point)
)
Expand Down

0 comments on commit 833f43a

Please sign in to comment.