Start working on meow-tutor

[VitalyAnkh]

Let's improve meow's documentation and make this great package newbie-friendly!

[VitalyAnkh]

My current plan: replicate a vim tutor for meow.
Draft here: https://github.com/meow-edit/meow/blob/cf53d48a13913f83ef247af43e864288d485ffb1/meow-tutor.el

[Linerre]

If I'd like to contribute to tutorial stuff, which branch should I consider opening a PR to then? The new meow-tutorial branch or the master?

[DogLooksGood]

@Linerre we use meow-tutorial. you are in the meow-edit group, you can just push directly.

the same let you know @skmd0

[skmd0]

@DogLooksGood I am currently going over the meow-tutorial. Will submit changes after I am done.

[skmd0]

@VitalyAnkh Great job on writing the tutorial. 👍

I find it a great introduction for new people. I am currently fixing some grammatical mistakes and improving the brevity/phrasing of the content. I have made quite a few changes so I will open a PR after I am done.

[VitalyAnkh]

@skmd0 Thanks! Wating for your PR. 😸

[DogLooksGood]

Let me separate it into a text file and meow-tutor.el.

simple text file is easy to maintain, and I can focus on meow-tutor.el.

[DogLooksGood]

pushed

[DogLooksGood]

since our recipe is not updated, so we can not extract it as a normal text file yet.
just extract it into a const string.

[DogLooksGood]

The movement commands in meow can be divided into four groups

basic movement, with explicit direction.

left/right/prev/next
back-next/word-symbol

regexp-search-ring related

mark-word/symbol (push)
visit (push)
search (use)

common movements

line block find till reverse join

thing-based movement

inner/bounds/beginning/end-of-thing

[DogLooksGood]

Putting too much content into the tutor is nod a good idea. so we can just pick a subset.

Also, bmacro is avdanced usage, maybe it's not necessary to be in tutor.

[VitalyAnkh]

BMACRO is powerful! We should convince new users meow is powerful and worth using. We could just introduce a little bmacro.

[DogLooksGood]

Looks like we have our first version?

[DogLooksGood]

I write a small command, hope it can help

(defvar meow-tutor-ovs nil)

(defun meow-tutor-toggle ()
  (interactive)
  (if meow-tutor-ovs
      (progn
        (mapc (lambda (o)
                (delete-overlay o))
              meow-tutor-ovs)
        (setq meow-tutor-ovs nil))
    (save-mark-and-excursion
      (goto-char (point-min))
      (while 
          (re-search-forward "\\\\\\\\\\[meow-.+?\\]" nil t)
        (let* ((m (match-data))
               (b (car m))
               (e (cadr m))
               (o (make-overlay b e)))
          (push o meow-tutor-ovs)
          (overlay-put o 'display "X")
          (overlay-put o 'face 'error))))))

(global-set-key (kbd "<f5>") 'meow-tutor-toggle)

press F5 to toggle the display.

---

Great job! I'll commit for some minor changes and add visit, search.

[DogLooksGood]

I've finished sections for find/till, visit/search and keypad.

I believe the tutorial is pretty good for now.

Please, add an ending section, and of course, something like written by ...

@VitalyAnkh @skmd0

[DogLooksGood]

Worth taking a look, there's another great progress by @Linerre

This could be our next tutorial I think.

[skmd0]

Wow that is really cool format!

[DogLooksGood]

merged into master, now M-x meow-tutor is available.

[Fedreg]

Just thought I'd chime in as a new meow user...

I pulled in meow-tutor and it was REALLY helpful; great job! on it!!

the additional sections that @skmd0 mentioned would definitely be helpful to newcomers (but it's already really good even without...)

thx!!