mirror of
https://github.com/seaweedfs/seaweedfs.git
synced 2024-01-19 02:48:24 +00:00
Update README.md
This commit is contained in:
parent
9ebbf655c0
commit
ed7b00bf02
67
README.md
67
README.md
|
@ -5,41 +5,6 @@ Seaweed File System
|
||||||
[![GoDoc](https://godoc.org/github.com/chrislusf/weed-fs/go?status.svg)](https://godoc.org/github.com/chrislusf/weed-fs/go)
|
[![GoDoc](https://godoc.org/github.com/chrislusf/weed-fs/go?status.svg)](https://godoc.org/github.com/chrislusf/weed-fs/go)
|
||||||
[![RTD](https://readthedocs.org/projects/weed-fs/badge/?version=latest)](http://weed-fs.readthedocs.org/en/latest/)
|
[![RTD](https://readthedocs.org/projects/weed-fs/badge/?version=latest)](http://weed-fs.readthedocs.org/en/latest/)
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```
|
|
||||||
go get github.com/chrislusf/weed-fs/go/weed
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installation guide for users who are not familiar with golang
|
|
||||||
|
|
||||||
step 1: install go on your machine and setup the environment by following the instructions from the following link:
|
|
||||||
|
|
||||||
https://golang.org/doc/install
|
|
||||||
|
|
||||||
make sure you set up your $GOPATH
|
|
||||||
|
|
||||||
|
|
||||||
step 2: also you may need to install Mercurial by following the instructions below
|
|
||||||
|
|
||||||
http://mercurial.selenic.com/downloads
|
|
||||||
|
|
||||||
|
|
||||||
step 3: download, compile, and install the project by executing the following command
|
|
||||||
|
|
||||||
go get github.com/chrislusf/weed-fs/go/weed
|
|
||||||
|
|
||||||
once this is down, you should see the executable "weed" under $GOPATH/bin
|
|
||||||
|
|
||||||
step 4: after you modify your code locally, you could start a local build by calling "go build" under $GOPATH/src/github.com/chrislusf/weed-fs/go/weed
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Reference
|
|
||||||
|
|
||||||
For pre-compiled releases,
|
|
||||||
https://bintray.com/chrislusf/Weed-FS/seaweed
|
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
|
@ -271,12 +236,34 @@ More tools and documentation, on how to maintain and scale the system. For examp
|
||||||
|
|
||||||
This is a super exciting project! And I need helpers!
|
This is a super exciting project! And I need helpers!
|
||||||
|
|
||||||
## Contributions ##
|
|
||||||
|
|
||||||
To make contributions easier, I have mirrored a repo in github.com
|
## Installation guide for users who are not familiar with golang
|
||||||
```
|
|
||||||
https://github.com/chrislusf/weed-fs.git
|
step 1: install go on your machine and setup the environment by following the instructions from the following link:
|
||||||
```
|
|
||||||
|
https://golang.org/doc/install
|
||||||
|
|
||||||
|
make sure you set up your $GOPATH
|
||||||
|
|
||||||
|
|
||||||
|
step 2: also you may need to install Mercurial by following the instructions below
|
||||||
|
|
||||||
|
http://mercurial.selenic.com/downloads
|
||||||
|
|
||||||
|
|
||||||
|
step 3: download, compile, and install the project by executing the following command
|
||||||
|
|
||||||
|
go get github.com/chrislusf/weed-fs/go/weed
|
||||||
|
|
||||||
|
once this is done, you should see the executable "weed" under $GOPATH/bin
|
||||||
|
|
||||||
|
step 4: after you modify your code locally, you could start a local build by calling "go install" under $GOPATH/src/github.com/chrislusf/weed-fs/go/weed
|
||||||
|
|
||||||
|
## Reference
|
||||||
|
|
||||||
|
For pre-compiled releases,
|
||||||
|
https://bintray.com/chrislusf/Weed-FS/seaweed
|
||||||
|
|
||||||
## Disk Related topics ##
|
## Disk Related topics ##
|
||||||
|
|
||||||
### Hard Drive Performance ###
|
### Hard Drive Performance ###
|
||||||
|
|
Loading…
Reference in a new issue