🐝
 
 
 
 
 
Go to file
Manos Pitsidianakis 05d9ca6e0d
small fixes
2019-11-21 15:44:18 +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 small fixes 2019-11-21 15:44:18 +02:00
scripts scripts: remove auto-rustfmt from pre-commit hook 2019-06-10 19:40:33 +03:00
src ui/embed: fix scrolling area issues 2019-11-19 20:39:43 +02:00
testing Remove unused imports from testing/src/imap_conn.rs 2019-10-04 20:42:01 +03:00
tests Add tests/ dir and a test 2019-11-17 13:29:12 +02:00
text_processing text-processing: small line_break.rs fix 2019-11-21 15:39:56 +02:00
ui ui/pager: reflow on resize 2019-11-21 15:42:01 +02:00
.gdbinit small fixes 2019-11-21 15:44:18 +02: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 sqlite3 feature WIP 2019-11-08 15:13:41 +02:00
Cargo.toml Revert "Show manuals with command line arguments" 2019-10-24 12:19:29 +03:00
Makefile Small Makefile prettification 2019-11-18 12:56:52 +02:00
README melib: add notmuch backend 2019-11-15 22:56:45 +02:00
meli.1 melib: add notmuch backend 2019-11-15 22:56:45 +02:00
meli.conf.5 Add format_flowed option for composing e-mail 2019-11-17 13:27:22 +02:00
rustfmt.toml Run rustfmt 2019-06-10 19:40:39 +03:00
sample-config melib: add notmuch backend 2019-11-15 22:56:45 +02: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

BUILDING WITH NOTMUCH
=====================

To use the optional notmuch backend feature, you must have libnotmuch installed in your system. In Debian-like systems, install the "libnotmuch" package.

To build with notmuch support, prepend the environment variable "MELI_FEATURES='melib/notmuch_backend'" to your make invocation:

# MELI_FEATURES="melib/notmuch_backend" make

or if building directly with cargo, use the flag '--features="melib/notmuch_backend"'.

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