Since these commands are shell sessions in a terminal emulator and not
shell scripts, using this `shell-session` syntax. Moved the comments to
`<h6>` headings. Block titles ala AsciiDoc make a little more sense to
read and follow, but not access to that.
---
README.md | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index ff266af..8bd00ec 100644
--- a/README.md+++ b/README.md
@@ -79,11 +79,15 @@ The development environment is managed by
a shell with everything you need to get started with the lib: `cargo`,
`cargo-watch`, `rust-bin`, `rust-analyzer`, `notmuch`…
-```sh-# starts a nix shell+####### Starts a Nix shell++```shell-session$ nix-shell
+```++####### Then builds the lib-# then builds the lib+```shell-session$ cargo build
```
@@ -93,7 +97,7 @@ Before running the test suite you need to spawn an IMAP server. Here
an example with [`docker`](https://www.docker.com/) and
[`greenmail`](https://github.com/greenmail-mail-test/greenmail):
-```sh+```shell-session$ docker run -it --rm \
-p 3025:3025 -p 3110:3110 -p 3143:3143 -p 3465:3465 -p 3993:3993 -p 3995:3995 \
-e GREENMAIL_OPTS='-Dgreenmail.setup.test.all -Dgreenmail.hostname=0.0.0.0 -Dgreenmail.auth.disabled -Dgreenmail.verbose' \
--
2.38.1
---
README.md | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index f275a66..6ebec76 100644
--- a/README.md+++ b/README.md
@@ -42,16 +42,17 @@ before the `v1.0.0`.*
## Introduction
-The role of this library is to extract and expose an API for managing-emails. This way, you can build clients that match the best your-workflow without reiventing the wheel. Here the list of available+The role of this library is to extract and expose an+<abbr title="application programming interface">API</abbr> for+managing emails. This way, you can build clients that match the best+your workflow without reiventing the wheel. Here the list of availableclients built by the community:
-- [CLI](https://github.com/soywod/himalaya)+- [<abbr title="command-line interface">CLI</abbr>](https://github.com/soywod/himalaya)- [Vim plugin](https://git.sr.ht/~soywod/himalaya-vim)
- [Emacs plugin](https://git.sr.ht/~soywod/himalaya-emacs) (beta)
-- GUI (coming soon)-- TUI+- <abbr title="graphical user interface">GUI</abbr> (coming soon)+- <abbr title="text-based user interfaces">TUI</abbr>- Web server
- …
@@ -68,8 +69,8 @@ clients built by the community:
- Add, set and delete flags
- Multi-accounting
- Folder aliases
-- PGP end-to-end encryption-- IMAP IDLE mode for real-time notifications+- <abbr title="Pretty Good Privacy">PGP</abbr> end-to-end encryption+- <abbr title="Internet Message Access Protocol">IMAP</abbr> IDLE mode for real-time notifications- …
## Development
--
2.38.1
[PATCH 4/4] Proper casing for funding alt tag images