[docs] Added QEMU networking docs and created README index #866
Conversation
Signed-off-by: James Prestwood <[email protected]>
| @@ -9,6 +9,27 @@ This code requires a local copy of JerryScript and Zephyr OS source. We | |||
| will upstream patches to those projects as appropriate, but this repo is for | |||
| everything else. | |||
|
|
|||
| ### Index | |||
There was a problem hiding this comment.
This index is tl;dr. :) We need to pick out the 4-6 most interesting jumping off points and link to those, not every little subsection or we've lost the value of a quick index.
Also, maybe change the hierarchy and/or break things out into separate files. So unless you want to try to tackle that here, I'd probably just remove the index for now or put a very few bullets in it. Off-hand: Getting Started, Contributing, not sure - this doc needs a lot of work.
There was a problem hiding this comment.
Yeah I didn't want to open up that can of worms. Really, I started by just adding the QEMU docs, but then realized how terrible and long the readme was. I can though, we just may want to talk about what our main bullets should be, and then sort the existing sections into those categories.
|
Having such section is definitely a good idea, thanks. I won't argue that instead of duplicating instructions from https://www.zephyrproject.org/doc/subsystems/networking/qemu_setup.html, it should link there, but I'd say it definitely should link there in addition to those quick inline instructions, in case something changes on Zephyr side, or just for additional info. |
README.md
Outdated
| @@ -318,7 +339,7 @@ install this earlier, you can do so with the command: | |||
| sudo apt-get install node-uglify | |||
| ``` | |||
|
|
|||
| ## FRDM-K64F Platform | |||
| ## FRDM K64F Platform | |||
There was a problem hiding this comment.
The dash is how they identify it.
There was a problem hiding this comment.
I couldn't link the section with the dash. The (#section-name) uses dashes where there are spaces. I am not very proficient at markdown but if you know how to escape the dashes so it will work in the link I will do that.
There was a problem hiding this comment.
If you look here, the link already works, like this:
https://github.com/01org/zephyr.js#frdm-k64f-platform
So I think it would just work w/ the same one you used, with dashes.
README.md
Outdated
| @@ -376,7 +397,7 @@ Using the same procedure as above, once you hit Reset you should see | |||
|
|
|||
| Zephyr is a trademark of the Linux Foundation. *Other names and brands may be claimed as the property of others. | |||
|
|
|||
| ## Building and running on Linux/Mac OSX | |||
| ## Building and running on Linux and Mac OSX | |||
| In addition to Zephyr there is a "linux" target which does not use Zephyr at all | |||
| and instead uses the host OS. This can be build on Linux or Mac OSX using the | |||
There was a problem hiding this comment.
built, while you're here :)
Signed-off-by: James Prestwood <[email protected]>
Signed-off-by: James Prestwood <[email protected]>
jprestwo
force-pushed
the
networking-updates
branch
from
8452a30 to
59f2606
Compare
|
+1 |
Signed-off-by: James Prestwood [email protected]