Archives/meli - meli - blob42 source forge

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

Manos Pitsidianakis 9c3284d3fe ui/listings: add set_movement method to ListingComponent Page movements is an enum that describes the movements of the keyboard keys "Home, End, PageUp, PageDown". Some mail listing Components interpret these keys as changes to their cursors.		5 years ago
benches	melib: remove BackendOpGenerator	5 years ago
debug_printer	Fix warnings, lints, and 2018 errors	5 years ago
melib	Add license comment to melib/src/structs.rs	5 years ago
scripts	scripts: remove auto-rustfmt from pre-commit hook	5 years ago
src	bin: C-L issues manual redraw	5 years ago
testing	Remove unused imports from testing/src/imap_conn.rs	5 years ago
text_processing	Bump version to 0.3.2	5 years ago
ui	ui/listings: add set_movement method to ListingComponent	5 years ago
.gdbinit	add experimental gdb debug lib	5 years ago
.gitignore	Add Cargo.lock	5 years ago
COPYING	mailbox: add threads	5 years ago
Cargo.lock	Reexport debug-tracing feature from main Cargo.toml	5 years ago
Cargo.toml	Reexport debug-tracing feature from main Cargo.toml	5 years ago
Makefile	add Makefile for installation	5 years ago
README	Add info about debug logs in README and Cargo.toml	5 years ago
meli.1	conf: add a light theme option	5 years ago
meli.conf.5	Add doco for window_title option	5 years ago
rustfmt.toml	Run rustfmt	5 years ago
sample-config	conf: add a light theme option	5 years ago

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.

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