-
Notifications
You must be signed in to change notification settings - Fork 8
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
Update README #96
Update README #96
Conversation
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.
Thank you very much. It is much better. The commands are valid and working. But I am missing some info, in case something goes wrong.
The references to the substrate documentation are good, but it is unpleasant that in order to ensure that the different steps work as they should, you always have to refer to them.
I'm not explaining the things too in depth, because I don't think this is a tutorial for beginners. There are tutorials from substrate to cover the basics, such as the meaning of the different ports and similar. This is a README for developers that know how starting a parachain works, but don't necessarily know all commands by heart yet. So as long as the commands in the README work, that is good enough. Covering all necessary debugging information would require a lot more work. Which might get outdated quite soon again. |
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.
Thanks.
02ebff6
to
b8224cd
Compare
README.md
Outdated
``` | ||
depending on how you installed `polkadot-launch`. |
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.
I would prefer if we set a team standard here. Go with the second option but explain how to install it that way
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.
Updated it accordingly. The installation needs to be globally such that the 2nd option can be used. But that's already in the installation part of polkadot-launch. So I simply put a Link there. Is that alright?
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.
whereas "global" means "across all projects of the current user", not system-wide for all users. then it's ok as it does not demand special privileges
~/.yarn/bin/polkadot-launch
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.
Yes, it's per user. At least if yarn has been installed for per-user. It didn't require any sudo command, in my case, neither for yarn nor for polkadot-launch with -g
option.
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.
I like the simplification and decluttering.
Updates the README. Removed manual steps, but provided some necessary info (where to find id & cmds) to start it manually, in case it's necessary.
closes #92