From 6d87ffbc036f4a0efcb6cc962d4e2a37ef76ace5 Mon Sep 17 00:00:00 2001 From: tyranron Date: Sun, 25 Jan 2015 23:55:40 +0200 Subject: [PATCH] finished README.md --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1d5f689..21c9e58 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,14 @@ Golang sizeof tips ------------------ **Web tool for interactive playing with Golang struct sizes.** +Try online version [here](http://golang-sizeof.tips/). -## Install +## Aim +Provide comfortable tool to see how fields in struct are aligned, +to compare different structs and as the result - to understand +and remember alignment rules. + +## Installing To install correct versions of dependencies [Goop dependency manager](https://github.com/nitrous-io/goop) should be used. ```bash @@ -15,9 +21,17 @@ goop go build -o ./server You may also install via simple `go get` by your own risk. -## Starting, stoping, restarting +## Usage ```bash ./server -http=:7777 start ./server stop ./server restart ``` + +## Platform support +Tested on Linux and OS X x64 platforms, but should work properly and on other +*nix-like platforms. +Windows is not supported due to daemonization. + +## License +[Apache License 2.0](LICENSE)