Changes based on feedback

Steven L 2016-08-16 14:12:24 -04:00
parent 92143ce7d3
commit 2174d79ff7

28
FAQ.md

@ -3,15 +3,15 @@ Frequently Answered Questions
## Is this a replacement for IRC? ## Is this a replacement for IRC?
```ssh-chat``` and IRC have overlapping scenarios. ```ssh-chat``` right now doesn't have channels like IRC does, `ssh-chat` and IRC have overlapping scenarios. `ssh-chat` right now doesn't have channels like IRC does,
but for smaller projects and teams, ```ssh-chat``` might be better in the long run. ```ssh-chat``` identifies but for smaller projects and teams, `ssh-chat` might be better in the long run. `ssh-chat` identifies
users by their public keys so authentication is automatically handled by sshd. ```ssh-chat``` is also easier to set up since all a user has to do is connect via ssh to a specified IP as opposed to installing an IRC client, users by their public keys so authentication is automatically handled by sshd. `ssh-chat` is also easier to set up since all a user has to do is connect via ssh to a specified IP as opposed to installing an IRC client,
connecting to a server, and connecting to a specific channel. connecting to a server, and connecting to a specific channel.
## How can I build ssh-chat? ## How can I build ssh-chat?
First make sure you have a copy of the Go compiler (1.6+ should be fine). Next you need a workspace for First make sure you have a copy of the Go compiler (1.6+ should be fine). Next you need a workspace for
the Go compiler to do all of it's builds. Make a directory, something like ```work``` in your $HOME folder, the Go compiler to do all of it's builds. Make a directory, something like `work` in your $HOME folder,
where we can place the source folder into. where we can place the source folder into.
The next step is setting up our GOPATH so Go knows where it can start building and downloading packages. The next step is setting up our GOPATH so Go knows where it can start building and downloading packages.
@ -19,8 +19,8 @@ After that we can copy the source code into the GOPATH directory for compiling.
``` bash ``` bash
mkdir ~/work mkdir ~/work
export GOPATH=~/work # add this to your .bashrc/.zshrc file to save you time export GOPATH=~/work # add this to your .bashrc/.zshrc file to save you time
git clone https://github.com/shazow/ssh-chat ~/work/src/github.com/shazow go get github.com/shazow/ssh-chat
cd ~/work/src/github.com/shazow/ssh-chat cd $GOPATH/src/github.com/shazow/ssh-chat
make make
``` ```
That should make the workspace directory, export the GOPATH to your environment, clone the That should make the workspace directory, export the GOPATH to your environment, clone the
@ -32,19 +32,19 @@ into during the build process.
## How can I contribute to ssh-chat? ## How can I contribute to ssh-chat?
So once you've set up the build phase, you can start contributing right away! ```ssh-chat``` uses So once you've set up the build phase, you can start contributing right away! `ssh-chat` uses
Golang, so if you are familiar with C/C++ or Java, Golang should be a snap. Check out the following Go, so if you are familiar with C/C++ or Java, Go should be a snap. Check out the following
sites for quick insight into the Go language. sites for quick insight into the Go language.
* [A Tour of Go](https://tour.golang.org/welcome/1) * [A Tour of Go](https://tour.golang.org/welcome/1)
* [Go By Example](https://gobyexample.com/) * [Go By Example](https://gobyexample.com/)
Next, before you start committing changes, you will want to create a different branch to work on, and Next, before you start committing changes, you will want to create a different branch to work on, and
fork ```ssh-chat``` so you can create Pull Requests. First create a fork, then we will go over how to fork `ssh-chat` so you can create Pull Requests. First create a fork, then we will go over how to
create a branch. create a branch.
Once you've forked ```ssh-chat```, go into your shell and create a new Git branch. Name it something Once you've forked `ssh-chat`, go into your shell and create a new Git branch. Name it something
based on what you're adding to the project. Try for simple names like ```readme-fix``` or ```new-themes```, based on what you're adding to the project. Try for simple names like `readme-fix` or `new-themes`,
something short and easy that describes a feature or addition. Then, you check out into that new branch something short and easy that describes a feature or addition. Then, you check out into that new branch
you made. you made.
@ -66,7 +66,7 @@ we're on a different branch. We need to set a remote that we can push these chan
git remote add myrepo https://github.com/my-username/ssh-chat git remote add myrepo https://github.com/my-username/ssh-chat
git push -u myrepo git push -u myrepo
``` ```
That should push your changes to your repository instead of the ```ssh-chat``` repository. Now you can That should push your changes to your repository instead of the `ssh-chat` repository. Now you can
create a Pull Request which will compare your changes to the upstream's (original repository) Git, and create a Pull Request which will compare your changes to the upstream's (original repository) Git, and
if the changes are approved by the owner, then they will get merged! if the changes are approved by the owner, then they will get merged!
@ -82,7 +82,7 @@ might be able to check the settings to see if it has URL support.
## Can I block users from connecting? ## Can I block users from connecting?
Yes. ```ssh-chat``` has a whitelisting feature which allows you to take users' public keys and add them to a Yes. `ssh-chat` has a whitelisting feature which allows you to take users' public keys and add them to a
whitelist, so that only they may connect when their public key matches the authorized keys given to ```ssh-chat```. whitelist, so that only they may connect when their public key matches the authorized keys given to `ssh-chat`.