Skip to content

Commit

Permalink
docs: clarify setup with Doom module (#663)
Browse files Browse the repository at this point in the history
Some things are handled by the module.

Ref: meow-edit/doom-meow#3

Co-authored-by: 45mg <[email protected]>
  • Loading branch information
45mg and 45mg authored Nov 7, 2024
1 parent 36c86fb commit 811849f
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion GET_STARTED.org
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,22 @@ You can write your own setup function from scratch or pick one from below as you
- [[file:KEYBINDING_COLEMAK.org][Colemak layout]]

* Enable meow globally
Add the following code to your configuration.
Add the following code to your configuration, assuming that your function to set
up bindings is called ~meow-setup~:
#+begin_src emacs-lisp
<define your meow-setup>
(require 'meow)
(meow-setup)
(meow-global-mode 1)
#+end_src

NOTE: You don't need to do this if you use the [[https://github.com/meow-edit/doom-meow][Doom module]], as it takes care of
loading and enabling Meow. In addition the module defines ~+meow--setup-*~
functions for all the example layouts included here, so that passing the
corresponding module flag is enough to set up those layouts. (If you want to use
a custom layout, you will need to define your own setup function and call it in
your configuration.)

* Tutorial in Emacs
Now you can open the tutorial with ~M-x meow-tutor~.

Expand Down

0 comments on commit 811849f

Please sign in to comment.