[docs] update readme in core project #265
Conversation
benschac
force-pushed
the
updatereadme
branch
from
82b95df to
c90537a
Compare
README.md
Outdated
|
|
||
| ```sh | ||
| cargo build --release | ||
| cargo build --release -p entropy |
There was a problem hiding this comment.
documented here in discord: https://discord.com/channels/852509982582767677/893156091398094868/1039984264520945775
There was a problem hiding this comment.
mmmm this is a mis understanding this will only build the chain not the threshold server
There was a problem hiding this comment.
gotcha, I'll revert
There was a problem hiding this comment.
The issue here is that build doesn't really do anything, since entropy (and server) got built on line 30.
change this to cargo run --release -p entropy (or just ./target/release/entropy, I still think the former is better, but if you change it, change all references of ./target/release/BIN to cargo run --release -p BIN)
README.md
Outdated
| @@ -58,19 +59,19 @@ node. | |||
| This command will start the single-node development chain with persistent state: | |||
|
|
|||
| ```bash | |||
| ./target/release/node-template --dev | |||
| ./target/release/entropy --dev | |||
There was a problem hiding this comment.
update docs to use entropy project shell command.
benschac
changed the title
README.md
Outdated
|
|
||
| ```sh | ||
| cargo build --release | ||
| cargo build --release -p entropy |
There was a problem hiding this comment.
The issue here is that build doesn't really do anything, since entropy (and server) got built on line 30.
change this to cargo run --release -p entropy (or just ./target/release/entropy, I still think the former is better, but if you change it, change all references of ./target/release/BIN to cargo run --release -p BIN)
partial update of docs
|
@jakehemmerle -- seems like you want to take this one over. Happy to close this and you open a PR with your changes. They're clearly more detailed than mine. If you don't could you update the PR description with a short description of what you did and how someone could go about testing these documentation changes? This looks really good, ty for cleaning up these docs! |
|
@benschac thanks! just wanted to work off of what you had started so it didn't get stale. testing them is just running the commands |
|
small comment: link substrate pallet docs in readme too. |
done |
* move build instructions to top of readme * update build command * replace all references of node-template with entropy * Update README.md partial update of docs * Update README.md --------- Co-authored-by: Jake Hemmerle <jakehemmerle@protonmail.com>
It's not possible to run the run step without first building the
coreproject. Moving the build step ahead of the run step is the sequential step a developer needs to take to get the project working.