Skip to content

Commit b92a59c

Browse files
committed
Update README
1 parent faadd1f commit b92a59c

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

Diff for: README.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ To install it:
3535
### Installing in Spacemacs ###
3636

3737
1. Clone the repository to the `private/local` subdirectory of your `.emacs.d` directory, where you installed spacemacs.
38-
2. Add the package to the `dotspacemacs-additional-packages` and mark is as local. That's Spacemacs' feature to make it easy to load locally installed packages.
38+
2. Add the package to the `dotspacemacs-additional-packages` and mark it as local. That's Spacemacs' feature to make it easy to load locally installed packages.
3939

4040
```lisp
4141
dotspacemacs-additional-packages '((gdscript-mode :location local))
4242
```
4343

44-
3. In your user-config function, require the package.
44+
3. In your `dotspacemacs/user-config` function, require the package.
4545

4646
```lisp
4747
(defun dotspacemacs/user-config ()
@@ -50,21 +50,24 @@ dotspacemacs-additional-packages '((gdscript-mode :location local))
5050

5151
### Installing in Doom Emacs ###
5252

53-
1. Add the following line to your .doom.d/packages.el file
53+
Add the following package definition to your `.doom.d/packages.el` file:
5454

5555
```lisp
56-
(package! gdscript-mode :recipe (:host github :repo "GDQuest/emacs-gdscript-mode"))
56+
(package! gdscript-mode
57+
:recipe (:host github
58+
:repo "GDQuest/emacs-gdscript-mode"
59+
:files ("*.el" "data/*.txt")))
5760
```
5861

59-
2. Require the package in your .doom.d/config.el file
62+
Require the package in your `.doom.d/config.el` file:
6063

6164
```lisp
6265
(require 'gdscript-mode)
6366
```
6467

6568
## Formatting with gdformat ##
6669

67-
You can call the `gdscript-format` function to format the current buffer with `gdformat`. This features requires the python package `gdtoolkit` to be installed and available on the system's PATH variable.
70+
You can call the `gdscript-format` function to format the current buffer with `gdformat`. This feature requires the python package `gdtoolkit` to be installed and available on the system's PATH variable.
6871

6972
You can install gdtoolkit using the pip package manager from Python 3. Run this command in your shell to install it:
7073

0 commit comments

Comments
 (0)