summary refs log tree commit diff
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2020-10-29 11:44:17 -0400
committerJune McEnroe <june@causal.agency>2020-10-29 11:44:17 -0400
commit98fef012f601338bdf1f1a55b16aec1ca44464fe (patch)
tree1601550028c37396b1b976bbbb15c1d26256cd9b
parentSay OpenSSL in additional permission notices (diff)
downloadimbox-98fef012f601338bdf1f1a55b16aec1ca44464fe.tar.gz
imbox-98fef012f601338bdf1f1a55b16aec1ca44464fe.zip
Update build instructions
Diffstat (limited to '')
-rw-r--r--README.750
1 files changed, 17 insertions, 33 deletions
diff --git a/README.7 b/README.7
index 7898f93..c309347 100644
--- a/README.7
+++ b/README.7
@@ -1,4 +1,4 @@
-.Dd May  2, 2020
+.Dd October 29, 2020
 .Dt README 7
 .Os "Causal Agency"
 .
@@ -11,44 +11,28 @@
 is a small TLS-only IMAP client
 intended for applying git patches
 without need of any other mail client.
-It requires LibreSSL
-.Pq Fl ltls
-and either
-.Xr dig 1
-or
-.Xr drill 1
-for automatic IMAP server configuration.
-.
-.Pp
 .Xr git-fetch-email 1
 is a wrapper modeled after
 .Xr git-send-email 1 .
 .
 .Pp
-Build configuration can be written to
-.Pa config.mk .
-The install prefix of LibreSSL is set by
-.Va LIBRESSL_PREFIX .
-The path of
+.Nm
+requires
+.Sy libtls ,
+provided by either
+.Lk https://git.causal.agency/libretls/about LibreTLS
+(for OpenSSL)
+or by LibreSSL.
+On systems other than FreeBSD,
 .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.
+is required for
+automatic IMAP server configuration.
+.
+.Bd -literal -offset indent
+\&./configure
+make all
+sudo make install
+.Ed
 .
 .Sh CONTRIBUTING
 The upstream URL of this project is
span>ui-snapshot.c: Do not reinvent suffixcmp()Lukas Fleischer Use suffixcmp() from Git instead of reimplementing it. This is a preparation for moving to ends_with() in Git 1.8.6. Signed-off-by: Lukas Fleischer <cgit@cryptocrack.de> 2014-01-10Refactor cgit_parse_snapshots_mask()Lukas Fleischer Use Git string lists instead of str{spn,cspn,ncmp}() magic. This significantly improves readability. Signed-off-by: Lukas Fleischer <cgit@cryptocrack.de> 2014-01-10Disallow use of undocumented snapshot delimitersLukas Fleischer Since the introduction of selective snapshot format configuration in dc3c9b5 (allow selective enabling of snapshots, 2007-07-21), we allowed seven different delimiters for snapshot formats, while the documentation has always been clear about spaces being the only valid delimiter: The value is a space-separated list of zero or more of the values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Supporting the undocumented delimiters makes the code unnecessarily complex. Remove them. Signed-off-by: Lukas Fleischer <cgit@cryptocrack.de> 2014-01-10Replace most uses of strncmp() with prefixcmp()Lukas Fleischer This is a preparation for replacing all prefix checks with either strip_prefix() or starts_with() when Git 1.8.6 is released. Signed-off-by: Lukas Fleischer <cgit@cryptocrack.de> 2014-01-09README: Fix dependenciesLukas Fleischer * Remove the dependency on Git (which can be obtained automatically when building, using either the Git submodule or `make get-git`). * Use proper upstream names of dependencies. Signed-off-by: Lukas Fleischer <cgit@cryptocrack.de> 2014-01-08README: Spelling and formatting fixesLukas Fleischer * Several small spelling and capitalization fixes. * Use consistent and better-looking formatting that is compatible with AsciiDoc (and partly compatible with RST). Signed-off-by: Lukas Fleischer <cgit@cryptocrack.de> 2014-01-08Fix UTF-8 with syntax-highlighting.pyPřemysl Janouch Previously the script tried to encode output from Pygments with the ASCII codec, which failed. Signed-off-by: Přemysl Janouch <p.janouch@gmail.com> 2014-01-08Add a suggestion to the manpagePřemysl Janouch So that people wishing to use "enable-http-clone" don't have to find out the correct settings on their own. Signed-off-by: Přemysl Janouch <p.janouch@gmail.com> 2014-01-08Fix the example configurationPřemysl Janouch "enable-git-clone" doesn't exist, replaced with "enable-http-clone". Signed-off-by: Přemysl Janouch <p.janouch@gmail.com> 2014-01-08Fix about-formatting.shPřemysl Janouch dash failed to parse the script. Signed-off-by: Přemysl Janouch <p.janouch@gmail.com> 2014-01-08Fix some spelling errorsPřemysl Janouch Signed-off-by: Přemysl Janouch <p.janouch@gmail.com> 2014-01-08filters: highlight.sh: add css comments for highlight 2.6 and 3.8Ferry Huberts