Browse Source

README cleanup and formatting

Mokhtar Naamani 4 years ago
parent
commit
d5ac60719a
2 changed files with 20 additions and 21 deletions
  1. 16 9
      README.md
  2. 4 12
      node/README.md

+ 16 - 9
README.md

@@ -12,13 +12,14 @@ functionality to support the [various roles](https://www.joystream.org/roles) th
 Development [![Development Branch Build Status](https://travis-ci.org/Joystream/joystream.svg?branch=development)](https://travis-ci.org/Joystream/joystream) - build history on [Travis](https://travis-ci.org/github/Joystream/joystream/builds)
 
 ## Development Tools
+
 The following tools are required for building, testing and contributing to this repo:
 
-- [Rust](https://www.rust-lang.org/tools/install) toolchain - *required*
-- [nodejs](https://nodejs.org/)  v12.x - *required*
-- [yarn classic](https://classic.yarnpkg.com/en/docs/install) package manager v1.22.x- *required*
-- [docker](https://www.docker.com/get-started) - *optional*
-- [ansible](https://www.ansible.com/) - *optional*
+- [Rust](https://www.rust-lang.org/tools/install) toolchain - _required_
+- [nodejs](https://nodejs.org/) v12.x - _required_
+- [yarn classic](https://classic.yarnpkg.com/en/docs/install) package manager v1.22.x- _required_
+- [docker](https://www.docker.com/get-started) - _optional_
+- [ansible](https://www.ansible.com/) - _optional_
 
 If you use VSCode as your code editor we recommend using the workspace [settings](devops/vscode/settings.json) for recommend eslint plugin to function properly.
 
@@ -39,26 +40,32 @@ yarn cargo-checks
 ## Software
 
 **Substrate blockchain**
+
 - [joystream-node](./node)
 - [runtime](./runtime)
 - [runtime modules](./runtime-modules)
 
 **Server Applications - infrastructure**
+
 - [Storage Node](./storage-node) - Media Storage Infrastructure
-- [Query Node](https://github.com/Joystream/joystream/tree/query_node/query-node) - *under development*
-- [Discovery Node](https://github.com/Joystream/joystream/tree/init_discovery_node/discovery_node) - *under development*
+- [Query Node](https://github.com/Joystream/joystream/tree/query_node/query-node) - _under development_
+- [Discovery Node](https://github.com/Joystream/joystream/tree/init_discovery_node/discovery_node) - _under development_
 
 **Front-end Applications**
+
 - [Pioneer](./pioneer) - Main UI for accessing all Joystream features
-- [Atlas](https://github.com/Joystream/joystream/tree/init_atlas/atlas) - Media Player- *under development*
+- [Atlas](https://github.com/Joystream/joystream/tree/init_atlas/atlas) - Media Player- _under development_
 
 **Tools and CLI**
+
 - [joystream-cli](./cli) - CLI for community and governance activities
 
 **Testing infrastructure**
+
 - [Network integration](./tests/network-tests) - Joystream network integration testing framework
 
 ## Exploring the network with Pioneer
+
 Pioneer is currently the main web interface to interact with the network:
 
 We currently host it on: https://testnet.joystream.org
@@ -74,12 +81,12 @@ git checkout master
 yarn install
 yarn workspace pioneer start
 ```
+
 This runs a local development web server on port 3000.
 
 Use the link below to browse the network using the publicly hosted endpoint:
 http://localhost:3000/?rpc=wss://rome-rpc-endpoint.joystream.org:9944/
 
-
 ## Running a local full node
 
 You can also run your our own joystream-node:

+ 4 - 12
node/README.md

@@ -6,8 +6,7 @@ joystream-node is the main server application that connects to the network, sync
 
 To setup a full node and validator review the [advanced guide from the helpdesk](https://github.com/Joystream/helpdesk/tree/master/roles/validators).
 
-
-###  Pre-built Binaries
+### Pre-built Binaries
 
 The latest pre-built binaries can be downloaded from the [releases](https://github.com/Joystream/joystream/releases) page.
 Generally these will be built from master branch and relevant to the current active testnet.
@@ -29,6 +28,7 @@ compile the node and runtime
 ```bash
 cargo build --release
 ```
+
 This produces the binary in `./target/release/joystream-node`
 
 ### Running Local development chain
@@ -80,17 +80,9 @@ yarn workspace joystream-testing test
 ```
 
 To run the integration tests with a different chain, you can omit step running the local development chain and set the node URL using `NODE_URL` environment variable.
-Proposal grace periods should be set to 0, otherwise proposal network tests will fail.
-
-### Rome-Constantinople migration network test
-
-Ensure Rome node is up and running, and node URL is set using `NODE_URL` environment variable (default value is `localhost:9944`).
-
-```bash
-yarn test-migration
-```
 
 ### Installing a release build
+
 If you are building a tagged release from master branch and want to install the executable to your path follow the step below.
 
 This will install the executable `joystream-node` to your `~/.cargo/bin` folder, which you would normally have in your `$PATH` environment.
@@ -102,5 +94,5 @@ cargo install joystream-node --path node/
 Now you can run and connect to the rome testnet:
 
 ```bash
-joystream-node --chain rome.json
+joystream-node --chain testnets/rome.json
 ```