Skip to content
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

Merged
merged 2 commits into from
Feb 21, 2023
Merged

fix typos in readme #276

merged 2 commits into from
Feb 21, 2023

Conversation

benschac
Copy link
Contributor

@benschac benschac commented Feb 3, 2023

Fix spelling and formatting issues in README

This PR addresses the following:

  • Typos
  • Inconsistencies in formatting
  • adds formatting via prettier markdown defaults

@benschac
Copy link
Contributor Author

benschac commented Feb 3, 2023

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
Copy link
Contributor Author

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@benschac benschac force-pushed the fix_typos_in_readme branch from cbbe751 to df2f70e Compare February 3, 2023 14:03
- 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
Copy link
Contributor Author

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
Copy link
Contributor Author

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

Copy link
Contributor Author

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
Copy link
Contributor Author

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/).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove line break

@benschac benschac force-pushed the fix_typos_in_readme branch from df2f70e to 83458df Compare February 3, 2023 14:16
@benschac benschac requested a review from jakehemmerle February 3, 2023 14:17
@benschac benschac marked this pull request as ready for review February 3, 2023 14:20
README.md Outdated Show resolved Hide resolved
@benschac
Copy link
Contributor Author

benschac commented Feb 3, 2023

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.

@benschac benschac requested a review from jakehemmerle February 3, 2023 20:13
@ok-john ok-john self-requested a review February 3, 2023 20:23
ok-john
ok-john previously approved these changes Feb 3, 2023
JesseAbram
JesseAbram previously approved these changes Feb 3, 2023
@benschac benschac dismissed stale reviews from JesseAbram and ok-john via c2b68ed February 6, 2023 18:52
@benschac benschac force-pushed the fix_typos_in_readme branch from 164da76 to c2b68ed Compare February 6, 2023 18:52
@benschac
Copy link
Contributor Author

bumping @jakehemmerle to get this in your queue? This LGTM?

jakehemmerle
jakehemmerle previously approved these changes Feb 16, 2023
@benschac benschac merged commit a6cb8f2 into master Feb 21, 2023
@benschac benschac deleted the fix_typos_in_readme branch February 21, 2023 16:00
fjarri pushed a commit that referenced this pull request May 5, 2023
* fix typos in readme

* Capitalize first word in lists
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants