You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Manos Pitsidianakis fa121820f7
3 years ago
benches melib: remove BackendOpGenerator 3 years ago
debug_printer Fix warnings, lints, and 2018 errors 3 years ago
melib pre-alpha-0.3.1 3 years ago
scripts scripts: remove auto-rustfmt from pre-commit hook 3 years ago
src ui: add timer tick every 300ms 3 years ago
testing pre-alpha-0.3.1 3 years ago
text_processing pre-alpha-0.3.1 3 years ago
ui pre-alpha-0.3.1 3 years ago
.gdbinit add experimental gdb debug lib 3 years ago
.gitignore mailbox: add threads 3 years ago
COPYING mailbox: add threads 3 years ago
Cargo.toml pre-alpha-0.3.1 3 years ago
Makefile add Makefile for installation 3 years ago
README Add info about debug logs in README and Cargo.toml 3 years ago
meli.1 update manual page and add meli.conf(5) 3 years ago
meli.conf.5 ui: add PGP settings in configuration 3 years ago
rustfmt.toml Run rustfmt 3 years ago
sample-config update manual page and add meli.conf(5) 3 years ago


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

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


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

With Cargo available, the project can be built with

# make

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


# 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.


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.


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


How to run specific tests:

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


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