From 5cb6adc0a1dd013b66ba9bb128862be42a03d3bf Mon Sep 17 00:00:00 2001 From: unusualevent <111516305+unusualevent@users.noreply.github.com> Date: Fri, 28 Jul 2023 02:23:34 -0600 Subject: [PATCH] add more explicit install instructions --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 112d092..30baa8d 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,28 @@ Features: See info below, the [API docs](http://godoc.org/github.com/cretz/bine), and the [examples](examples). The project is MIT licensed. The Tor docs/specs and https://github.com/yawning/bulb were great helps when building this. +## Installing +Bine requires tor-static, which cannot be installed by go's package manager. + +Instead: +``` +mkdir -p ~/go/src/github.com/cretz +git clone --recursive https://github.com/cretz/tor-static ~/go/src/github.com/cretz/tor-static +pushd ~/go/src/github.com/cretz/tor-static +go run build.go build-all +popd +go get github.com/cretz/bine +``` +## Requirements +- perl-FindBin (fedora) +- autotools +- gettext-devel (fedora, the package that provides autopoint) +- glibc-static + +## If you have build errors +> here is how to make go run build.go build-all verbose... + + ## Example It is really easy to create an onion service. For example, assuming `tor` is on the `PATH`, this bit of code will show