From 68f1a1a260fc771a96f5a25d26d518e238101ed3 Mon Sep 17 00:00:00 2001 From: Jeromy Date: Sat, 27 Sep 2014 18:50:38 -0700 Subject: [PATCH] update readme and a couple comments --- README.md | 20 +++++++++++++++----- cmd/ipfs/gen.go | 3 ++- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 81a231ac489..c9f9f14fbfa 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,11 @@ cd $GOPATH/src/github.com/jbenet/go-ipfs/cmd/ipfs go install ``` -NOTE: `git` and mercurial (`hg`) are required in order for `go get` to fetch all dependencies. +NOTE: `git` and mercurial (`hg`) are required in order for `go get` to fetch +all dependencies. -If you are interested in development, please install the development dependencies as well. +If you are interested in development, please install the development +dependencies as well. ## Usage @@ -46,15 +48,23 @@ Use "ipfs help " for more information about a command. ``` ## Getting Started -To start using ipfs, you must first initialize ipfs's config files on your system, this is done with `ipfs init`. See `ipfs help init` for information on arguments it takes. After initialization is complete, you can use `ipfs mount`, `ipfs add` and any of the other commands to explore! +To start using ipfs, you must first initialize ipfs's config files on your +system, this is done with `ipfs init`. See `ipfs help init` for information on +arguments it takes. After initialization is complete, you can use `ipfs mount`, +`ipfs add` and any of the other commands to explore! -NOTE: if you have previously installed ipfs before and you are running into problems getting it to work, try deleting (or backing up somewhere else) your config directory (~/.go-ipfs/config by default) and rerunning `ipfs init`. +NOTE: if you have previously installed ipfs before and you are running into +problems getting it to work, try deleting (or backing up somewhere else) your +config directory (~/.go-ipfs by default) and rerunning `ipfs init`. ## Contributing -go-ipfs is MIT licensed open source software. We welcome contributions big and small! Please make sure to check the [issues](https://github.com/jbenet/go-ipfs/issues). Search the closed ones before reporting things, and help us with the open ones. +go-ipfs is MIT licensed open source software. We welcome contributions big and +small! Please make sure to check the +[issues](https://github.com/jbenet/go-ipfs/issues). Search the closed ones +before reporting things, and help us with the open ones. Guidelines: diff --git a/cmd/ipfs/gen.go b/cmd/ipfs/gen.go index e54b092470c..b7b29846a56 100644 --- a/cmd/ipfs/gen.go +++ b/cmd/ipfs/gen.go @@ -14,7 +14,8 @@ import ( type CommanderFunc func(*commander.Command, []string) error -// Wraps a commands.CmdFunc so that it may be safely run by the commander library +// MakeCommand Wraps a commands.CmdFunc so that it may be safely run by the +// commander library func MakeCommand(cmdName string, expargs []string, cmdFn commands.CmdFunc) CommanderFunc { return func(c *commander.Command, inp []string) error { if len(inp) < 1 {