Skip to content

Commit 2e05a10

Browse files
authored
Update README.md
1 parent 8d030ad commit 2e05a10

File tree

1 file changed

+9
-118
lines changed

1 file changed

+9
-118
lines changed

README.md

+9-118
Original file line numberDiff line numberDiff line change
@@ -1,124 +1,15 @@
1-
# iotex-core
1+
# Dynamic Sharding
2+
This is a dynamic sharding implementation using the IoTeX protocol.
3+
### Example
24

3-
[![Join the chat at https://gitter.im/iotex-dev-community/Lobby](https://badges.gitter.im/iotex-dev-community/Lobby.svg)](https://gitter.im/iotex-dev-community/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
4-
[![Go version](https://img.shields.io/badge/go-1.11.5-blue.svg)](https://github.com/moovweb/gvm)
5-
[![CircleCI](https://circleci.com/gh/iotexproject/iotex-core.svg?style=svg&circle-token=fe0817d127f251a34b8bdd3336a808c7537e5ec0)](https://circleci.com/gh/iotexproject/iotex-core)
6-
[![Go Report Card](https://goreportcard.com/badge/github.com/iotexproject/iotex-core)](https://goreportcard.com/report/github.com/iotexproject/iotex-core)
7-
[![Coverage](https://codecov.io/gh/iotexproject/iotex-core/branch/master/graph/badge.svg)](https://codecov.io/gh/iotexproject/iotex-core)
8-
[![Godoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](https://godoc.org/github.com/iotexproject/iotex-core)
9-
[![Releases](https://img.shields.io/github/release/iotexproject/iotex-core/all.svg?style=flat-square)](https://github.com/iotexproject/iotex-core/releases)
10-
[![LICENSE](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
5+
## Introduction
116

12-
![IoTeX Logo](logo/IoTeX.png)
13-
----
7+
### Motivation
148

15-
Welcome to the official Go implementation of IoTeX protocol! IoTeX is building the next generation of the decentralized
16-
network for IoT powered by scalability- and privacy-centric blockchains. Please refer to IoTeX
17-
[whitepaper](https://iotex.io/academics) for details.
9+
### Use case scale
1810

19-
## Get started
11+
## Technical Details
2012

21-
### Minimum requirements
13+
### Algorithm
2214

23-
| Components | Version | Description |
24-
|----------|-------------|-------------|
25-
| [Golang](https://golang.org) | ≥ 1.11.5 | Go programming language |
26-
| [Dep](https://golang.github.io/dep/) | ≥ 0.5.0 | Dependency management tool, required only when you update dependencies |
27-
| [Protoc](https://developers.google.com/protocol-buffers/) | ≥ 3.6.0 | Protocol buffers, required only when you rebuild protobuf messages |
28-
29-
### Get iotex-core
30-
31-
The easiest way to get iotex-core is to use one of release packages which are available for OSX, Linux on the
32-
[release page](https://github.com/iotexproject/iotex-core/releases). Iotex-core is also distributed via docker image
33-
on [docker hub](https://hub.docker.com/r/iotex/iotex-core).
34-
35-
36-
### Build iotex-core from code
37-
38-
Download the code by
39-
```
40-
mkdir -p ~/go/src/github.com/iotexproject
41-
cd ~/go/src/github.com/iotexproject
42-
git clone git@github.com:iotexproject/iotex-core.git
43-
cd iotex-core
44-
```
45-
46-
Build the project by
47-
48-
```
49-
make
50-
```
51-
52-
If the dependency needs to be updated, run
53-
54-
```
55-
dep ensure [--vendor-only]
56-
```
57-
58-
59-
Run unit tests only by
60-
61-
```
62-
make test
63-
```
64-
65-
Build the docker image by
66-
67-
```
68-
make docker
69-
```
70-
71-
### Run iotex-core
72-
73-
Start (or resume) a standalone server to operate on an blockchain by
74-
75-
```
76-
make run
77-
```
78-
79-
Restart the server from a clean state by
80-
81-
```
82-
make reboot
83-
```
84-
85-
If "make run" fails due to corrupted or missing state database while block database is in normal condition, e.g.,
86-
failing to get factory's height from underlying DB, please try to recover state database by
87-
88-
```
89-
make recover
90-
```
91-
92-
Then, "make run" again.
93-
94-
Note that if your enviroment is in Linux, you need to add the share libraries into `$LD_LIBRARY_PATH` by
95-
96-
```
97-
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$GOPATH/src/github.com/iotexproject/iotex-core/crypto/lib
98-
```
99-
100-
### Use CLI
101-
102-
Users could interact with iotex blockchain by
103-
104-
```
105-
ioctl [command]
106-
```
107-
108-
Refer to [CLI document](cli/ioctl/README.md) for more details.
109-
110-
## Contact
111-
112-
- Mailing list: [iotex-dev](iotex-dev@iotex.io)
113-
- IRC: [gitter](https://gitter.im/iotex-dev-community/Lobby)
114-
- Bugs: [issues](https://github.com/iotexproject/iotex-core/issues)
115-
116-
117-
## Contribution
118-
We are glad to have contributors out of the core team; contributions, including (but not limited to) style/bug fixes,
119-
implementation of features, proposals of schemes/algorithms, and thorough documentation, are welcomed. Please refer to
120-
our [contribution guideline](CONTRIBUTING.md) for more
121-
information. Development guide documentation is [here](https://github.com/iotexproject/iotex-core/wiki/Developers%27-Guide).
122-
123-
## License
124-
This project is licensed under the [Apache License 2.0](LICENSE).
15+
## Training Data

0 commit comments

Comments
 (0)