Update the htrun readme #307
Conversation
rajkan01
commented
Jun 14, 2021
rajkan01
commented
- Updated the htrun readme based on standalone greentea
src/htrun/README.md
Outdated
| # Development moved | ||
|
|
||
| The development of Htrun has been moved into the [mbed-os-tools](../../src/mbed_os_tools) package. You can continue to use this module for legacy reasons, however all further development should be continued in the new package. | ||
| The development of Htrun (mbed-host-tests) has been moved into the [mbed-greentea](https://github.com/ARMmbed/greentea/tree/master) repository under `src/htrun`. You can continue to use this module for legacy reasons, however all further development should be continued in the mbed-greentea repository. |
There was a problem hiding this comment.
I don't think we need this paragraph here. This repository is already ARMmbed/greentea so there's no "legacy reason" here.
It's probably a leftover notice when development of greentea was moved during early days of Mbed.
There was a problem hiding this comment.
I think this paragraph to give some warning to the user as this source moved from a different repo and we will keep this notice until we remove the htrun source from mbed-os-tools
There was a problem hiding this comment.
Normally a warning is in an old place asking users to look at the new place, rather than in the new place itself like here. I mean, when a user sees this notice, they might think this repo is deprecated, which is the opposite.
I don't mind too much for now as it's a minor detail.
rajkan01
force-pushed
the
update_htrun_readme
branch
from
d745982 to
25e0428
Compare
There was a problem hiding this comment.
Thanks @rajkan01. As this PR aims to ensure information in the README is generally correct and up-to-date, without any major refactoring or improvements, it looks good to me.
I've just added a few minor comments when I read through the doc again.
rajkan01
force-pushed
the
update_htrun_readme
branch
from
6b59eca to
35bb9ce
Compare
3 participants
