From 811849fe562cdb452b25051db9a2bf6be3dee164 Mon Sep 17 00:00:00 2001
From: 45mg <45mm.cartridge421@slmail.me>
Date: Thu, 7 Nov 2024 08:42:02 +0000
Subject: [PATCH] docs: clarify setup with Doom module (#663)

Some things are handled by the module.

Ref: https://github.com/meow-edit/doom-meow/issues/3

Co-authored-by: 45mg <45mg@no.mail>
---
 GET_STARTED.org | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/GET_STARTED.org b/GET_STARTED.org
index 10e84ec..8e542cd 100644
--- a/GET_STARTED.org
+++ b/GET_STARTED.org
@@ -40,7 +40,8 @@ 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)
@@ -48,6 +49,13 @@ Add the following code to your configuration.
   (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~.