Update README.md #21
Update README.md #21
Conversation
adamralph
left a comment
adamralph
left a comment
There was a problem hiding this comment.
After these changes, I still don't know what running run.bat is going to do to my machine.
|
@adamralph That is why I'm asking @tmasternak and @mikeminutillo if we would want to copy the first section of the tutorial in the README as that contains what happens. Would that help? |
|
@ramonsmits I see. Yes, I think that would help. Currently it's not at all obvious that I should follow that link to find what running run.bat will do to my machine. The two things are in different parts of the document. |
|
@adamralph can you have a look at current version? I've added single sentence per each option that explicitly states what the script will do. |
tmasternak
left a comment
tmasternak
left a comment
There was a problem hiding this comment.
I've added by changes in commits
adamralph
left a comment
adamralph
left a comment
There was a problem hiding this comment.
@tmasternak the added notes about what the script will do look good.
Does the script do enough to call out any other pre-requisities? E.g. if I have a clean Windows installation, does the README act as an entry point to all the required instructions to get the demo runnnig?
|
|
||
| Self-contained demo showing all of the monitoring components working together. This accompanies the Particular Platform Monitoring Tutorial available at the following location: | ||
|
|
||
| - https://docs.particular.net/tutorials/monitoring/demo/ |
There was a problem hiding this comment.
Yes this is 404 until we merge the tutorial:/ (which should be today or tomorrow)
Yes if you have a fresh Windows installation pre-requisites are all you need to have the demo running. |
|
@adamralph I'm merging this PR. We can polish the |
Based on feedback by @adamralph
@mikeminutillo @tmasternak Might we just past the whole first section of the tutorial in the readme instead of linking to it?