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 3aec1f6dec
Bump version to 0.2.0
hace 3 semanas
benches melib: remove BackendOpGenerator hace 1 mes
debug_printer Fix warnings, lints, and 2018 errors hace 2 meses
melib Fix: This comment is not a proper rustdoc comment and probably should not be one anyways hace 3 semanas
scripts scripts: remove auto-rustfmt from pre-commit hook hace 2 meses
src Reformat to be a proper rust comment hace 3 semanas
testing text_processing: implement Unicode line breaking algorithm hace 4 semanas
text_processing Make function pub hace 3 semanas
ui ui: fix pageup/dn behaviour hace 3 semanas
.gdbinit add experimental gdb debug lib hace 2 meses
.gitignore mailbox: add threads hace 2 meses
COPYING mailbox: add threads hace 2 meses
Cargo.toml Bump version to 0.2.0 hace 3 semanas
README Add build instructions in README hace 1 mes
meli.1 Add --version command line flag hace 3 semanas
rustfmt.toml Run rustfmt hace 2 meses
sample-config melib: add read-only support for mbox hace 3 semanas

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