commit 814d74c9aaeb95536923ba995adfc5ac50464739
from: Omar Polo <op@omarpolo.com>
date: Sat Jul 30 17:47:25 2022 UTC

tweak the readme

mention new instructions for building and other minor tweaks.

commit - 0efd7c9a43ed9b0fe0b47cdc09e91334d11d1909
commit + 814d74c9aaeb95536923ba995adfc5ac50464739
blob - 8fd29229af019e74c3f373d299d5155de463e4b3
blob + 45d81770c9315a62409f847033a018925f07dd3d
--- README.md
+++ README.md
@@ -1,26 +1,40 @@
 # lstun -- lazy ssh tunnel
 
 lstun is a simple utility to lazily (on demand) spawn a ssh tunnel to
-a remote machine and kill it after some time of inactivity.
+a remote machine and optionally kill it after some time of inactivity.
 
-Note that the the -main branch targets OpenBSD only; on other systems
-please use the -portable branch.
+The only dependency is libevent.  It expects ssh to be `/usr/bin/ssh`,
+compile with `-DSSH_PATH=...` to alter the path eventually.
 
 To compile it just run
 
+	$ ./configure
 	$ make
+	# make install # eventually
 
-The only dependency is libevent.  It expects ssh to be `/usr/bin/ssh`,
-compile with `-DSSH_PATH=...` to alter the path eventually.
+The build can be customized by passing arguments to the configure
+script or by using a `configure.local` file; see `./configure -h` and
+[`configure.local.example`](configure.local.example) for more
+information.
 
+The `configure` script can use pkg-config if available to find the
+flags for libevent.  To disable the usage of it, pass
+`PKG_CONFIG=false` to the configure script.
 
+For Linux users with libbsd installed, the configure script can be
+instructed to use libbsd instead of the bundled compats as follows:
+
+	CFLAGS="$(pkg-config --cflags libbsd-overlay)" \
+	    ./configure LDFLAGS="$(pkg-config --libs libbsd-overlay)"
+
+
 ### Usage
 
 ```
 usage: lstun [-dv] -B sshaddr -b addr [-t timeout] destination
 ```
 
-Check out the manpage for further the usage.
+Check out the [manpage](lstun.1) for the usage.
 
 
 ### Motivation