0ct0pu5/meli-terminal-mail-client
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

BUILD.md: move melib specific stuff to melib/README.md

Browse source 
Signed-off-by: Manos Pitsidianakis <manos@pitsidianak.is>
This commit is contained in:
Manos Pitsidianakis 2024-12-04 12:48:54 +02:00
parent 4a61a4b857
commit 80e5347178
No known key found for this signature in database
GPG key ID: 7729C7707F7E09D0
2 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
BUILD.md
View file

@ -20,7 +20,11 @@ You can build and run `meli` with one command: `cargo run --release`.
## Build features
Some functionality is held behind "feature gates", or compile-time flags. The following list explains each feature's purpose:
Some functionality is held behind "feature gates", or compile-time flags.
Cargo features for `melib` are documented in its [`README.md`](./melib/README.md) file.
The following list explains each feature's purpose:
- `gpgme` enables GPG support via `libgpgme` (on by default)
- `dbus-notifications` enables showing notifications using `dbus` (on by default)
@ -30,9 +34,6 @@ Some functionality is held behind "feature gates", or compile-time flags. The fo
- `cli-docs` includes the manpage documentation compiled by either `mandoc` or `man` binary to plain text in `meli`'s command line. Embedded documentation can be viewed with the subcommand `meli man [PAGE]` (on by default).
- `static` and `*-static` bundle C libraries in dependencies so that you don't need them installed in your system (on by default).
Though not a feature, the presence of the environment variable `UNICODE_REGENERATE_TABLES` in compile-time of the `melib` crate will force the regeneration of unicode tables.
Otherwise the tables are included with the source code, and there's no real reason to regenerate them unless you intend to modify the code or update to a new Unicode version.
## Build Debian package (*deb*)
Building with Debian's packaged cargo might require the installation of these two packages: `librust-openssl-sys-dev librust-libdbus-sys-dev`

3
melib/README.md
View file

@ -37,6 +37,9 @@ A list of all the features and a description for each follows:
| <a name="nntp-trace-feature">`nntp-trace`</a> | `nntp` feature | Connection trace logs on the `trace` logging level |
| <a name="smtp-trace-feature">`smtp-trace`</a> | `smtp` feature | Connection trace logs on the `trace` logging level |
Though not a feature, the presence of the environment variable `UNICODE_REGENERATE_TABLES` at compile-time of the `melib` crate will force the regeneration of Unicode tables from the crate's `build.rs` script.
Otherwise the tables are already included with the source code, and there's no real reason to regenerate them unless you intend to modify the code or update to a new Unicode version.
## Example: Parsing bytes into an `Envelope`
An `Envelope` represents the information you can get from an email's headers