diff mbox series

[bug#71281,mumi] README.org: Update instructions to run mumi locally.

Message ID fe06fdf6-99c3-550a-5a93-4c8870541958@zoho.com
State New
Headers show
Series [bug#71281,mumi] README.org: Update instructions to run mumi locally. | expand

Commit Message

Luis Felipe May 30, 2024, 9:09 p.m. UTC
Hi,

The current instructions in the README don't seem to be enough to run mumi.

I'm attaching a patch with the instructions that worked for me (thanks 
to Felix Lechner for directions).

Cheers,

-- 
Luis Felipe López Acevedo
https://luis-felipe.gitlab.io/
diff mbox series

Patch

From 221d37de5e9ea5e79771cd61046eba750eae3feb Mon Sep 17 00:00:00 2001
From: Luis Felipe <sirgazil@zoho.com>
Date: Thu, 30 May 2024 15:47:26 -0500
Subject: [PATCH] README.org: Update instructions to run mumi locally.

* README.org (Running a local instance of mumi): Add missing steps and
update URL to local instance.
---
 README.org | 25 +++++++++++++------------
 1 file changed, 13 insertions(+), 12 deletions(-)

diff --git a/README.org b/README.org
index af0121f..970076e 100644
--- a/README.org
+++ b/README.org
@@ -14,25 +14,26 @@  run
 
 ** Running a local instance of mumi
 
-First copy some test mail data to be indexed:
+Run the following commands:
 
 #+begin_src shell
+  # 1. Copy some test mail data to be indexed:
   $ cp -a tests/data data
-#+end_src
-
-Then, to have these emails indexed, run:
-
-#+begin_src shell
+  # 2. Download Pico CSS:
+  $ wget -P /tmp/ https://github.com/picocss/pico/archive/refs/tags/v1.5.6.tar.gz
+  # 3. Add Pico CSS to mumi assets:
+  $ tar -xf /tmp/v1.5.6.tar.gz -C assets/pico/ --strip-components=1
+  # 4. Build mumi:
+  $ ./bootstrap.sh
+  $ ./configure
+  $ make
+  # 5. Have the test mail data indexed:
   $ ./pre-inst-env mumi fetch
-#+end_src
-
-Finally, to start the mumi instance, run:
-
-#+begin_src shell
+  # 6. Start the mumi instance:
   $ ./pre-inst-env mumi web
 #+end_src
 
-You should now be able to visit http://localhost:1234 in your browser
+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

base-commit: 99416ed5c7d950eaf54d52023a2efd975bccac92
-- 
2.41.0