Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add more explicit install instructions #81

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add more explicit install instructions #81

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bine does not require tor-static. That's only if you want to link it statically (i.e. you opt in by importing github.com/cretz/bine/process/embedded). This is mentioned under "Example".

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't get it to work without tor-static existing, so I guess the example doesn't work.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please be more specific about the error you are encountering when running the example. Are you sure you are following all the steps such as "assuming tor is on the PATH"?


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
Expand Down