diff mbox series

[bug#68680,mumi,v3,1/4] README.org: Add new sections to help newcomers get started.

Message ID 20240126022717.31305-2-maxim.cournoyer@gmail.com
State New
Headers show
Series Add a button to copy a message Message-ID to the clipboard. | expand

Commit Message

Maxim Cournoyer Jan. 26, 2024, 2:26 a.m. UTC 
* README.org (Running a local instance of mumi): New section.
(Disabling browser caching): Likewise.
---

(no changes since v1)

 README.org | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
diff mbox series

Patch

diff --git a/README.org b/README.org
index fd1d77b..d092de7 100644
--- a/README.org
+++ b/README.org
@@ -11,3 +11,27 @@  run
 #+BEGIN_SRC shell
   $ guix shell -D mumi
 #+END_SRC
+
+** Running a local instance of mumi
+
+First copy some test mail data to be indexed:
+
+#+begin_src shell
+  $ cp -a tests/data data
+#+end_src
+
+Then, to have these emails indexed, run:
+
+#+begin_src shell
+  $ ./pre-inst-env mumi fetch
+#+end_src
+
+You should now be able to visit http://0.0.0.0:1234 in your browser
+and see your local mumi instance running.
+
+** Disabling browser caching
+
+If you modify the CSS or JavaScript source files, you'll want to make
+sure your browser doesn't keep cached copies.  This can be done by
+changing a preference in the development tools menus, which is called
+something like "Disable cache (while DevTools is active)".