From 28470aa7b7ef4683825765c3b51496775ebe87c4 Mon Sep 17 00:00:00 2001 From: Sam Mauldin Date: Wed, 17 Dec 2014 21:28:01 -0600 Subject: [PATCH] Merge compiling + developing sections, describe license section --- README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 769f894..1e59d06 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,17 @@ The server's RSA key fingerprint is `e5:d5:d1:75:90:38:42:f6:c7:03:d7:d0:56:7d:6 (Apologies if the server is down, try again shortly.) +## Compiling / Developing + +You can compile ssh-chat by using `make build`. The resulting binary is portable and +can be run on any system with a similar OS and CPU arch. Go 1.3 or higher is required to compile. + +If you're developing on this repo, there is a handy Makefile that should set +things up with `make run`. + +Additionally, `make debug` runs the server with an http `pprof` server. This allows you to open +[http://localhost:6060/debug/pprof/]() and view profiling data. See +[net/http/pprof](http://golang.org/pkg/net/http/pprof/) for more information about `pprof`. ## Quick Start @@ -46,11 +57,6 @@ $ ssh-chat --verbose --bind ":2022" --identity ~/.ssh/id_dsa To bind on port 22, you'll need to make sure it's free (move any other ssh daemons to another port) and run ssh-chat as root (or with sudo). -## Compiling - -You can compile ssh chat by using `make build`. The ssh chat binary is portable and -can be run on any system with a similar OS. Go 1.3 or higher is required to compile. - ## Deploying with Docker You can run ssh-chat using a Docker image without manually installing go-lang: @@ -62,14 +68,6 @@ $ docker run -d -p 0.0.0.0:(your host machine port):2022 --name ssh-chat alvin/s See notes in the header of our Dockerfile for details on building your own image. - -## Developing - -If you're developing on this repo, there is a handy Makefile that should set -things up with `make run`. - -Additionally, `make debug` runs the server with an http `pprof` server. This allows you to open [http://localhost:6060/debug/pprof/]() and view profiling data. See [net/http/pprof](http://golang.org/pkg/net/http/pprof/) for more information about `pprof`. - ## License -MIT +This project is licensed under the MIT open source license.