-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix typos in readme #276
fix typos in readme #276
Conversation
Current dependencies on/for this PR:
This comment was auto-generated by Graphite. |
@@ -75,72 +75,75 @@ by appending your own. A few useful ones are as follow. | |||
## Testnet | |||
|
|||
- Currently our network requires 2 binaries | |||
- ``` cargo build --release ``` will build both |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
triple backtick is for code blocks. Single is for inline code block
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cbbe751
to
df2f70e
Compare
- to run both you can reference /scripts/sdk-entropy-node.sh for the chain and /scripts/sdk-alice-tss.sh for the threshold client | ||
|
||
### Changing Defaults |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consistency, add upper case titles for headers
README.md
Outdated
|
||
### changing defaults | ||
- all defaults are ready to go out the box but can be changed if needed with varying degrees of difficult |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
most list markdown has been -
, updated *
--> -
for consistency
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Secret phrase `where sight patient orphan general short empower hope party hurt month voice` is account: | ||
Network ID/version: substrate | ||
Secret seed: 0xb0b5348db82db32d10a37b578e4c6242e148f14648661dccf8b3002fafa72cdd |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
trim white space via standard prettier markdown formatting
|
||
### Run in Docker | ||
|
||
First, install [Docker](https://docs.docker.com/get-docker/) and | ||
[Docker Compose](https://docs.docker.com/compose/install/). | ||
First, install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove line break
df2f70e
to
83458df
Compare
In a follow-up PR on top of this PR, I can test the README and go through every single command to ensure they work. Delete/update if the command/instruction is outdated or irrelevant. |
164da76
to
c2b68ed
Compare
bumping @jakehemmerle to get this in your queue? This LGTM? |
c2b68ed
to
0f6803e
Compare
* fix typos in readme * Capitalize first word in lists
Fix spelling and formatting issues in
README
This PR addresses the following: