🐝 I really like where this mua is(was?) headed, but it seems as though there has not been much activity recently.
 
 
 
 
 
Go to file
Manos Pitsidianakis 6b5ed25289
Add history browse option in execute bar
Press Ctrl-P and Ctrl-N to get previous and next command in history.
2019-11-08 15:09:25 +02:00
benches melib: remove BackendOpGenerator 2019-07-18 20:14:14 +03:00
debug_printer Fix warnings, lints, and 2018 errors 2019-06-18 21:14:14 +03:00
melib imap: reconnect if connection timed out 2019-11-02 12:25:18 +02:00
scripts scripts: remove auto-rustfmt from pre-commit hook 2019-06-10 19:40:33 +03:00
src Add embed pty support 2019-11-05 08:37:27 +02:00
testing Remove unused imports from testing/src/imap_conn.rs 2019-10-04 20:42:01 +03:00
text_processing Bump version to 0.3.2 2019-09-28 12:25:44 +03:00
ui Add history browse option in execute bar 2019-11-08 15:09:25 +02:00
.gdbinit add experimental gdb debug lib 2019-06-10 19:40:50 +03:00
.gitignore Revert "Show manuals with command line arguments" 2019-10-24 12:19:29 +03:00
COPYING mailbox: add threads 2019-06-10 19:11:47 +03:00
Cargo.lock Add embed pty support 2019-11-05 08:37:27 +02:00
Cargo.toml Revert "Show manuals with command line arguments" 2019-10-24 12:19:29 +03:00
Makefile add Makefile for installation 2019-09-16 16:41:22 +03:00
README Add information about building on debian systems 2019-10-24 20:40:44 +03:00
build.rs fixup manual 2019-10-24 12:18:56 +03:00
meli.1 Revert "Show manuals with command line arguments" 2019-10-24 12:19:29 +03:00
meli.conf.5 ui: option to embed editor in composing tab 2019-11-05 08:37:58 +02:00
rustfmt.toml Run rustfmt 2019-06-10 19:40:39 +03:00
sample-config conf: add a light theme option 2019-10-06 11:31:53 +03:00

README

    __
 __/  \__
/  \__/  \__                       .
\__/  \__/  \    , _ , _     ___   │   '
/  \__   \__/    │' `│  `┒ .'   `  │   │
\__/  \__/  \    │   │   │ |────'  │   │
   \__/  \__/    │       / `.___, /\__ /
      \__/
                                    ,-.
                                    \_/
        terminal mail user agent   {|||)<
                                    / \
                                    `-'
DOCUMENTATION
=============

After installing meli, see meli(1) and meli.conf(5) for documentation.

BUILDING
========

meli requires rust 1.34 and rust's package manager, Cargo. Information on how
to get it on your system can be found here:

https://doc.rust-lang.org/cargo/getting-started/installation.html

With Cargo available, the project can be built with

# make

The resulting binary will then be found under target/release/meli

Run:

# make install

to install the binary and man pages. This requires root, so I suggest you override the default paths and install it in your $HOME:

# make PREFIX=$HOME/.local install

See meli(1) and meli.conf(5) for documentation.

You can build and run meli with one command:

# cargo run --release

While the project is in early development, meli will only be developed for the
linux kernel and respected linux distributions. Support for more UNIX-like OSes
is on the roadmap.

BUILDING IN DEBIAN
==================

Building with Debian's packaged cargo might require the installation of these
two packages: librust-openssl-sys-dev and librust-libdbus-sys-dev

DEVELOPMENT
===========

Development builds can be built and/or run with

# cargo build
# cargo run

There is a debug/tracing log feature that can be enabled by using the flag
`--feature debug-tracing` after uncommenting the features in `Cargo.toml`. The logs
are printed in stderr, thus you can run meli with a redirection (i.e `2> log`)

Code style follows the default rustfmt profile.

CONFIG
======

meli by default looks for a configuration file in this location:
# $XDG_CONFIG_HOME/meli/config

You can run meli with arbitrary configuration files by setting the MELI_CONFIG
environment variable to their locations, ie:

# MELI_CONFIG=./test_config cargo run

TESTING
=======

How to run specific tests:

# cargo test -p {melib, ui, meli} (-- --nocapture) (--test test_name)

PROFILING
=========

# perf record -g target/debug/bin
# perf script | stackcollapse-perf | rust-unmangle | flamegraph > perf.svg