From 53112538e1f47ed446848c5787a87350a2cc6e31 Mon Sep 17 00:00:00 2001 From: mms Date: Tue, 12 Nov 2024 23:15:34 +0100 Subject: doc: fix readme --- README.html | 45 +++++++++++++++++++++++---------------------- 1 file changed, 23 insertions(+), 22 deletions(-) (limited to 'README.html') diff --git a/README.html b/README.html index a4c1b26..f037bc6 100644 --- a/README.html +++ b/README.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Chotto @@ -201,11 +201,12 @@

Table of Contents

@@ -221,8 +222,8 @@ Chotto is an initial tagging script for Notmuch Chotto is written in Ruby and had a (quite) nice DSL for configuration.

-
-

1. Naming & Afew

+
+

1. Naming & Afew

Notmuch ecosystem already has a great script for initial tagging - afew. @@ -237,8 +238,8 @@ And because I love Ruby!

-
-

2. Prerequisites

+
+

2. Prerequisites

Chotto expects: @@ -272,8 +273,8 @@ If you use Windows, you have my sympathy.

-
-

3. Configuration

+
+

3. Configuration

Chotto expects the configuration file to be present in @@ -289,8 +290,8 @@ The user needs to add (at least) two blocks to the file: config & rule sets

-
-

4. Config

+
+

4. Config

Presently, the only option Config expects is the absolute path to the Notmuch database: @@ -308,8 +309,8 @@ Please, adjust the path to the valid location

-
-

5. Rule sets

+
+

5. Rule sets

The actual magic happens in Rule Sets which are sets of filters & tag modifications. @@ -352,12 +353,12 @@ msg.tags returns a mutable array, and we can mutate is as such.

Lastly, we save! the message in the database.

+
+
-

-Filter language -

-
- +
+

6. Filter language

+

We can quite easily filter messages based. Chotto accepts filters as:

@@ -412,7 +413,7 @@ You can test what is produced by calling #to_query_string on messag

Author: User Mms

-

Created: 2024-11-12 Tue 23:12

+

Created: 2024-11-12 Tue 23:15

Validate

-- cgit v1.2.3