Skip to content

Commit

Permalink
*: clean up doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
siddontang committed Jul 29, 2016
1 parent 9da62dd commit 8753f43
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 660 deletions.
28 changes: 0 additions & 28 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -37,33 +37,5 @@ format:
@cargo fmt -- --write-mode diff | grep "Diff at line" > /dev/null && cargo fmt -- --write-mode overwrite | grep -v "found TODO" || exit 0
@rustfmt --write-mode diff tests/tests.rs benches/benches.rs | grep "Diff at line" > /dev/null && rustfmt --write-mode overwrite tests/tests.rs benches/benches.rs | grep -v "found TODO" || exit 0

check_req:
DEPS_PATH=$(DEPS_PATH) GOROOT=$(GOROOT) ./scripts/check_req.sh

rocksdb:
DEPS_PATH=$(DEPS_PATH) ./scripts/build_rocksdb.sh

$(BIN_PATH)/pd-server:
@DEPS_PATH=$(DEPS_PATH) BIN_PATH=$(BIN_PATH) PATH=$(PATH):$(GOROOT)/bin GOROOT=$(GOROOT) ./scripts/build_pd.sh

pd: $(BIN_PATH)/pd-server

$(BIN_PATH)/tidb-server:
@DEPS_PATH=$(DEPS_PATH) BIN_PATH=$(BIN_PATH) PATH=$(PATH):$(GOROOT)/bin GOROOT=$(GOROOT) ./scripts/build_tidb.sh

tidb: $(BIN_PATH)/tidb-server

deps: rocksdb pd tidb

install: check_req deps release
@cp -f ./target/release/tikv-server $(BIN_PATH)

clean_pd:
@rm -f $(BIN_PATH)/pd-server

clean_tidb:
@rm -f $(BIN_PATH)/tidb-server

clean:
cargo clean
@rm -rf $(DEPS_PATH) $(BIN_PATH)
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,18 @@ This figure represents tikv-server software stack.

When a node starts, the metadata of node, store and region are registered into PD. The status of each Region and Store is reported to PD regularly.

### Usage
### Build

See [Usage](./USAGE.md) for how to install and run TiKV.
TiKV is a component in TiDB project, you must build and run it with TiDB and PD together.

The easily way to build TiDB project is to follow [user build guide](https://github.com/pingcap/docs/blob/master/op-guide/build.md).
If you are a developer, you can also follow [dev build guide](https://github.com/pingcap/docs/blob/master/dev-guide/build.md).

### Next steps

+ Read the [clustering doc](https://github.com/pingcap/docs/blob/master/op-guide/clustering.md) on how to run TiDB project.
+ Learn the [configuration explanation](https://github.com/pingcap/docs/blob/master/op-guide/configuration.md).
+ Use [docker](https://github.com/pingcap/docs/blob/master/op-guide/docker.md) to run TiDB project.

### Contributing

Expand Down

0 comments on commit 8753f43

Please sign in to comment.