Skip to content
This repository was archived by the owner on Feb 21, 2024. It is now read-only.

Commit 7b79bed

Browse files
authored
Merge pull request #42 from liuchengxu/add-ci-badge
Add CI badges to README
2 parents 979773f + a0886bb commit 7b79bed

1 file changed

Lines changed: 14 additions & 6 deletions

File tree

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
# Subspace Network Monorepo
2+
3+
[![Rust](https://github.com/subspace/subspace/actions/workflows/rust.yaml/badge.svg)](https://github.com/subspace/subspace/actions/workflows/rust.yaml)
4+
[![TypeScript](https://github.com/subspace/subspace/actions/workflows/typescript.yaml/badge.svg)](https://github.com/subspace/subspace/actions/workflows/typescript.yaml)
5+
26
This is a mono repository for [Subspace Network](https://www.subspace.network/) implementation, primarily containing
37
Subspace node/client using Substrate framework and farmer app implementations.
48

@@ -7,16 +11,20 @@ Proof-of-Capacity (PoC) consensus, which is a simplified version of Subspace usi
711
implemented as part of [Web 3 Foundation Open Grant](https://github.com/w3f/Open-Grants-Program/blob/master/applications/spartan_poc_consensus_module.md).
812

913
### Repository structure
14+
1015
The structure of this repository is the following:
11-
* `crates` contains Subspace-specific Rust crates used to build node and farmer, most are following Substrate naming conventions
12-
* `substrate` contains modified copies of Substrate's crates that we use for testing
13-
* `node-template-spartan` is the current implementation of the node for Spartan protocol (will be upgraded to Subspace soon)
16+
17+
- `crates` contains Subspace-specific Rust crates used to build node and farmer, most are following Substrate naming conventions
18+
- `substrate` contains modified copies of Substrate's crates that we use for testing
19+
- `node-template-spartan` is the current implementation of the node for Spartan protocol (will be upgraded to Subspace soon)
1420

1521
### How to run
22+
1623
This is a monorepo with multiple binaries and the workflow is typical for Rust projects:
17-
* `cargo run --bin node-template-spartan -- --dev --tmp` to run [a node](node-template-spartan)
18-
* `cargo run --release --bin spartan-farmer -- plot 256000 spartan` to [create a 1 GiB plot](crates/spartan-farmer#create-a-new-plot)
19-
* `cargo run --release --bin spartan-farmer -- farm` to [start farming](crates/spartan-farmer#start-the-farmer)
24+
25+
- `cargo run --bin node-template-spartan -- --dev --tmp` to run [a node](node-template-spartan)
26+
- `cargo run --release --bin spartan-farmer -- plot 256000 spartan` to [create a 1 GiB plot](crates/spartan-farmer#create-a-new-plot)
27+
- `cargo run --release --bin spartan-farmer -- farm` to [start farming](crates/spartan-farmer#start-the-farmer)
2028

2129
NOTE: You need to have `nightly` version of Rust toolchain with `wasm32-unknown-unknown` target available or else you'll get a compilation error.
2230

0 commit comments

Comments
 (0)