terminal e-mail client and e-mail client library https://meli.delivery
 
 
 
 
 
 
Go to file
Manos Pitsidianakis 3aec1f6dec
Bump version to 0.2.0
2019-08-02 01:00:54 +03: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 Fix: This comment is not a proper rustdoc comment and probably should not be one anyways 2019-08-02 01:00:54 +03:00
scripts scripts: remove auto-rustfmt from pre-commit hook 2019-06-10 19:40:33 +03:00
src Reformat to be a proper rust comment 2019-08-02 01:00:53 +03:00
testing text_processing: implement Unicode line breaking algorithm 2019-07-27 01:56:07 +03:00
text_processing Make function pub 2019-08-02 01:00:53 +03:00
ui ui: fix pageup/dn behaviour 2019-08-02 01:00:54 +03:00
.gdbinit add experimental gdb debug lib 2019-06-10 19:40:50 +03:00
.gitignore mailbox: add threads 2019-06-10 19:11:47 +03:00
COPYING mailbox: add threads 2019-06-10 19:11:47 +03:00
Cargo.toml Bump version to 0.2.0 2019-08-02 01:00:54 +03:00
README Add build instructions in README 2019-07-13 22:53:48 +03:00
meli.1 Add --version command line flag 2019-08-02 01:00:53 +03:00
rustfmt.toml Run rustfmt 2019-06-10 19:40:39 +03:00
sample-config melib: add read-only support for mbox 2019-07-28 20:20:14 +03:00

README

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

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 

# cargo build --release

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

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
===========

Development builds can be built and/or run with

# cargo build
# cargo run 2> debug.log

The debug logs can be disabled by setting debug-assertions to false in the
development profile in Cargo.toml. In the future debug logs will be a feature.

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 2> debug.log

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