diff options
| author | June McEnroe <june@causal.agency> | 2020-01-28 02:16:10 -0500 |
|---|---|---|
| committer | June McEnroe <june@causal.agency> | 2020-01-28 02:16:10 -0500 |
| commit | 3699a16f0c5fb3210706aead921670bf3a6a71fb (patch) | |
| tree | 5e12082def6f56a0fd0c6e0add66266a42eadf96 | |
| parent | Add compat.h (diff) | |
| download | notemap-3699a16f0c5fb3210706aead921670bf3a6a71fb.tar.gz notemap-3699a16f0c5fb3210706aead921670bf3a6a71fb.zip | |
Add README
| -rw-r--r-- | README.7 | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/README.7 b/README.7 new file mode 100644 index 0000000..6ee5d96 --- /dev/null +++ b/README.7 @@ -0,0 +1,62 @@ +.Dd January 28, 2020 +.Dt README 7 +.Os "Causal Agency" +. +.Sh NAME +.Nm notemap +.Nd mirror notes to IMAP +. +.Sh DESCRIPTION +.Xr notemap 1 +mirrors text files to an IMAP mailbox +in a format compatible with the iOS Notes app. +It's intended to make notes managed in +.Xr git 1 +easily accessible from the phone. +. +.Pp +.Nm +requires LibreSSL +.Pq Fl ltls +and either +.Xr dig 1 +or +.Xr drill 1 +for automatic IMAP server configuration. +. +.Pp +Build configuration can be written to +.Pa config.mk . +The install prefix of LibreSSL is set by +.Va LIBRESSL_PREFIX . +The path of +.Xr dig 1 +or +.Xr drill 1 +can be set by defining the C preprocessor macro +.Va DIG_PATH +or +.Va DRILL_PATH , +respectively. +The default is to set +.Va DRILL_PATH +to +.Pa /usr/bin/drill +on +.Fx +and set +.Va DIG_PATH +to +.Pa dig +everywhere else. +. +.Sh CONTRIBUTING +The upstream URL of this project is +.Aq Lk https://git.causal.agency/notemap . +I'm happy to receive contributions in any form at +.Aq Mt june@causal.agency . +For sending patches by email, see +.Aq Lk https://git-send-email.io . +. +.Sh SEE ALSO +.Xr notemap 1 |