Skip to content

Commit

Permalink
update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
erickyan86 committed Feb 20, 2019
1 parent 36bc33c commit 54d2a35
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 16 deletions.
45 changes: 36 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,55 @@

Welcome to the Fractal source code repository!

## Homepage
https://fractalproject.com/
## What is Fractal?
Fractal is a high-level blockchain framework that can implement the issuance, circulation, and dividends of tokens efficiently and reliably. Fractal can also steadily implement various community governance functions with voting as the core and foundation. These functions are the foundation for building the token economy of future.

## Official documents
[白皮书](https://fractalproject.com/fractal-whitepaper.pdf) [whitepaper](https://fractalproject.com/fractal-whitepaper-en.pdf)
home page: https://fractalproject.com/

[技术白皮书](https://fractalproject.com/fractal-technical-whitepaper.pdf) [technical whitepaper](https://fractalproject.com/fractal-technical-whitepaper-en.pdf)

## Executables

The fractal project comes with several wrappers/executables found in the `cmd` directory.

| Command | Description |
|:----------:|-------------|
| **`ft`** | Our main fractal CLI client. It is the entry point into the fractal network (main-, test- or private net), It can be used by other processes as a gateway into the fractal network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `ft -h` and the [Command Line Options](https://github.com/fractalplatform/fractal/wiki/Command-Line-Options) for command line options. |
| **`fkey`** | fractal key manager. You can use it generate ,change and inspect a keyfile,also to sign and verify message. `fkey -h ` and the [Command Line Options](https://github.com/fractalplatform/fractal/wiki/Command-Line-Options) for command line options. |


## Getting Started
The following instructions overview the process of getting the code, building it, and running a simple test
The following instructions overview the process of getting the code, building it, and start node.

### Getting the code
To download all of the code:

`git clone https://github.com/fractalplatform/fractal`

### Setting up a build/development environment
TBD

### Running a simple test
TBD
Install latest distribution of [Go](https://golang.org/) if you don't have it already. (go version >= go1.9 )

Currently supports the following operating systems:

* Ubuntu 16.04
* Ubuntu 18.04
* MacOS Darwin 10.12 and higher

more information see: [Installing Fractal](https://github.com/fractalplatform/fractal/wiki/Build-Fractal)


### Running a node

To run `./ft ` , you can run your own FT instance.

`$ ft `

Join the fractal main network see: [Main Network](https://github.com/fractalplatform/fractal/wiki/Main-Network)

Join the fractal test network see: [Test Network](https://github.com/fractalplatform/fractal/wiki/Test-Network)

Operating a private network see:[Private Network](https://github.com/fractalplatform/fractal/wiki/Private-Network)



## License
Expand Down
2 changes: 0 additions & 2 deletions build/config.yaml

This file was deleted.

7 changes: 2 additions & 5 deletions cmd/ft/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ func init() {
// logging
falgs.BoolVar(&logConfig.PrintOrigins, "log_debug", logConfig.PrintOrigins, "Prepends log messages with call-site location (file and line number)")
falgs.IntVar(&logConfig.Level, "log_level", logConfig.Level, "Logging verbosity: 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail")
falgs.StringVar(&logConfig.Vmodule, "log_vmodule", logConfig.Vmodule, "Per-module verbosity: comma-separated list of <pattern>=<level> (e.g. eth/*=5,p2p=4)")
falgs.StringVar(&logConfig.Vmodule, "log_vmodule", logConfig.Vmodule, "Per-module verbosity: comma-separated list of <pattern>=<level> (e.g. ft/*=5,p2p=4)")
falgs.StringVar(&logConfig.BacktraceAt, "log_backtrace", logConfig.BacktraceAt, "Request a stack trace at a specific logging statement (e.g. \"block.go:271\")")

// config file
Expand All @@ -221,9 +221,7 @@ func init() {
falgs.BoolVar(&ftconfig.NodeCfg.WSExposeAll, "ws_exposeall", ftconfig.NodeCfg.WSExposeAll, "RPC:ws exposes all API modules via the WebSocket RPC interface rather than just the public ones.")

// ftservice
falgs.IntVar(&ftconfig.FtServiceCfg.DatabaseCache, "FtService_databasecache", ftconfig.FtServiceCfg.DatabaseCache, "Megabytes of memory allocated to internal database caching")

// consensus
falgs.IntVar(&ftconfig.FtServiceCfg.DatabaseCache, "databasecache", ftconfig.FtServiceCfg.DatabaseCache, "Megabytes of memory allocated to internal database caching")

// txpool
falgs.BoolVar(&ftconfig.FtServiceCfg.TxPool.NoLocals, "txpool_nolocals", ftconfig.FtServiceCfg.TxPool.NoLocals, "Disables price exemptions for locally submitted transactions")
Expand All @@ -246,7 +244,6 @@ func init() {
// gas price oracle
falgs.IntVar(&ftconfig.FtServiceCfg.GasPrice.Blocks, "gpo_blocks", ftconfig.FtServiceCfg.GasPrice.Blocks, "Number of recent blocks to check for gas prices")
falgs.IntVar(&ftconfig.FtServiceCfg.GasPrice.Percentile, "gpo_percentile", ftconfig.FtServiceCfg.GasPrice.Percentile, "Suggested gas price is the given percentile of a set of recent transaction gas prices")

falgs.BoolVar(&ftconfig.FtServiceCfg.MetricsConf.MetricsFlag, "test_metricsflag", ftconfig.FtServiceCfg.MetricsConf.MetricsFlag, "flag that open statistical metrics")
falgs.BoolVar(&ftconfig.FtServiceCfg.MetricsConf.InfluxDBFlag, "test_influxdbflag", ftconfig.FtServiceCfg.MetricsConf.InfluxDBFlag, "flag that open influxdb thad store statistical metrics")
falgs.StringVar(&ftconfig.FtServiceCfg.MetricsConf.Url, "test_influxdburl", ftconfig.FtServiceCfg.MetricsConf.Url, "url that connect influxdb")
Expand Down

0 comments on commit 54d2a35

Please sign in to comment.