diff --git a/FAQ.md b/FAQ.md index dfcf673..66f9b35 100644 --- a/FAQ.md +++ b/FAQ.md @@ -9,6 +9,7 @@ Frequently Answered Questions * [How can I click on URLs posted in chat?](https://github.com/shazow/ssh-chat/wiki/FAQ#how-can-i-click-on-urls-posted-in-chat) * [Can I block users from connecting? How do I assign admins?](https://github.com/shazow/ssh-chat/wiki/FAQ#can-i-block-users-from-connecting-how-do-i-assign-admins) * [How do I add color escape codes to my motd file?](https://github.com/shazow/ssh-chat/wiki/FAQ#how-do-i-add-color-escape-codes-to-my-motd-file) +* [How do I install ssh-chat and run it?](https://github.com/shazow/ssh-chat/wiki/FAQ/_edit#how-do-i-install-ssh-chat-and-run-it) ## Is this a replacement for IRC? @@ -136,3 +137,11 @@ If using ```nano```: Using simply ```bash```: ```echo -e "\x1b"``` + +## How do I install ssh-chat and run it? + +- If you [grabbed the binary releases](https://github.com/shazow/ssh-chat/releases), extract it and run it from the directory of where it was extracted or move the binary somewhere into your `$PATH`. + +- If you're compiling it, `make build` or `go build ./cmd/ssh-chat` will spit out the binary in the project root directory, so you'll need to `./ssh-chat` + +- If you're using `go get github.com/shazow/ssh-chat`, then the binary will be in your `$GOPATH/bin`. Add it to your `$PATH` or use the absolute path.