opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-06-29 17:36:38 +08:00
Code Issues Projects Releases Wiki Activity

update readme and a couple comments

Browse Source
This commit is contained in:
Jeromy
2014-09-27 18:50:38 -07:00
parent 727b6bf9a3
commit 68f1a1a260
2 changed files with 17 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -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 <command>" 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:

3
cmd/ipfs/gen.go
View File

@ -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 {