Skip to content
This repository has been archived by the owner on Nov 6, 2020. It is now read-only.

Update README.md #9084

Merged
merged 4 commits into from
Jul 12, 2018
Merged

Update README.md #9084

merged 4 commits into from
Jul 12, 2018

Conversation

5chdn
Copy link
Contributor

@5chdn 5chdn commented Jul 10, 2018

  • update depencies (cmake) ref update snappy #9082
  • update rust version
  • encourage final feature
  • change parity to parity ethereum

@5chdn 5chdn added A2-insubstantial 👶 Pull request requires no code review (e.g., a sub-repository hash update). M3-docs 📑 Documentation. labels Jul 10, 2018
@5chdn 5chdn added this to the 2.0 milestone Jul 10, 2018
@5chdn 5chdn requested a review from Tbaut July 10, 2018 09:27
dvdplm
dvdplm previously requested changes Jul 10, 2018

## [» Download the latest release «](https://github.com/paritytech/parity/releases/latest)
### [» Download the latest release «](https://github.com/paritytech/parity/releases/latest)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Don't we need to update this link as well to https://github.com/paritytech/parity-ethereum/releases/latest?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We are not there yet :)

curl -I https://github.com/paritytech/parity-ethereum/releases/latest
HTTP/1.1 404 Not Found

README.md Outdated

From Parity Ethereum client version 1.10.0, the User Interface (UI) is accessible in a separate application called Parity UI. To keep using the UI in the browser (deprecated), [follow these steps](https://wiki.parity.io/FAQ-Basic-Operations,-Configuration,-and-Synchronization#the-parity-ui-application-isnt-working-the-way-i-want).
From Parity-Ethereum client version 1.10.0, the User Interface (UI) is accessible in a separate application called Parity-UI. To keep using the UI in the browser (deprecated), [follow these steps](https://wiki.parity.io/FAQ-Basic-Operations,-Configuration,-and-Synchronization#the-parity-ui-application-isnt-working-the-way-i-want).
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd change this to "The UI for Parity-Ethereum is available in a separate application called … …" – not sure why anyone reading this would care about when the UI was extracted?

README.md Outdated

By default, Parity will also run a JSONRPC server on `127.0.0.1:8545` and a websockets server on `127.0.0.1:8546`. This is fully configurable and supports a number of APIs.
By default, Parity-Ethereum will also run a JSONRPC server on `127.0.0.1:8545` and a websockets server on `127.0.0.1:8546`. This is fully configurable and supports a number of APIs.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd remove the "also": up to this point in the text we haven't really stated what services we start.

s/websockets server/websocket server/

Copy link
Contributor

Choose a reason for hiding this comment

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

To be consistent with the --help: "JSON-RPC HTTP" and "Web Sockets" :)

README.md Outdated

If you run into an issue while using Parity, feel free to file one in this repository or hop on our [Gitter](https://gitter.im/paritytech/parity) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat room to ask a question. We are glad to help! **For security-critical issues**, please refer to the security policy outlined in [SECURITY.MD](SECURITY.md).
If you run into an issue while using Parity-Ethereum, feel free to file one in this repository or hop on our [Gitter](https://gitter.im/paritytech/parity) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat room to ask a question. We are glad to help! **For security-critical issues**, please refer to the security policy outlined in [SECURITY.MD](SECURITY.md).
Copy link
Collaborator

Choose a reason for hiding this comment

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

s/run into an issue/run into problems/ and then s/, feel free to file one/, feel free to file an issue in…/

```bash
$ rustup default stable-x86_64-pc-windows-msvc
$ rustup default stable-x86_64-pc-windows-msvc
```

Once you have rustup installed, then you need to install:
* [Perl](https://www.perl.org)
* [Yasm](http://yasm.tortall.net)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this true? I have not run into any assembly code in the code base, perhaps this is stale info?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have no clue about building on Windows.

Copy link
Collaborator

Choose a reason for hiding this comment

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

ring required perl and ASM to generate build some crypto-modules written in perl/ASM. So I think it is still true if nothing has changed in our fork of ring

Copy link
Collaborator

Choose a reason for hiding this comment

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

I see, thanks.

@5chdn 5chdn added the A1-onice 🌨 Pull request is reviewed well, but should not yet be merged. label Jul 10, 2018
@5chdn 5chdn modified the milestones: 2.0, 2.1 Jul 10, 2018
README.md Outdated

From Parity Ethereum client version 1.10.0, the User Interface (UI) is accessible in a separate application called Parity UI. To keep using the UI in the browser (deprecated), [follow these steps](https://wiki.parity.io/FAQ-Basic-Operations,-Configuration,-and-Synchronization#the-parity-ui-application-isnt-working-the-way-i-want).
By default, Parity-Ethereum will run a JSONRPC server on `127.0.0.1:8545` and a Web-Sockets server on `127.0.0.1:8546`. This is fully configurable and supports a number of APIs.
Copy link
Contributor

Choose a reason for hiding this comment

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

"JSON-RPC HTTP server" :)

Copy link
Contributor

@Tbaut Tbaut left a comment

Choose a reason for hiding this comment

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

LGTM with minor grumble 👍

@5chdn 5chdn added A8-looksgood 🦄 Pull request is reviewed well. A6-mustntgrumble 💦 Pull request has areas for improvement. The author need not address them before merging. and removed A1-onice 🌨 Pull request is reviewed well, but should not yet be merged. labels Jul 11, 2018
@5chdn 5chdn removed the A6-mustntgrumble 💦 Pull request has areas for improvement. The author need not address them before merging. label Jul 12, 2018
Copy link
Collaborator

@dvdplm dvdplm left a comment

Choose a reason for hiding this comment

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

lgtm

@Tbaut
Copy link
Contributor

Tbaut commented Jul 12, 2018

Shouldn't we add some basic explanations on how to DL and launch a binary?

@5chdn
Copy link
Contributor Author

5chdn commented Jul 12, 2018

This readme clearly needs some love. If you have time, happy to review a new revision. Also, it should have a prominent link to the wiki.

@5chdn 5chdn merged commit bab85dd into master Jul 12, 2018
@5chdn 5chdn deleted the a5-docs-readme branch July 12, 2018 16:55
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A2-insubstantial 👶 Pull request requires no code review (e.g., a sub-repository hash update). A8-looksgood 🦄 Pull request is reviewed well. M3-docs 📑 Documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants