Ben vd Veen has been working on a NuttX getting started book for a few
months. I don't know the current state. There was a channel on the old
NuttX Slack devoted to the book, but it has not been updated in a very
long time. Perhaps Ben could fill us in on the current state, progress,
and where it is going.
BTW: I have archived the channels and deactivated most of the members.
It is no longer viable for anything and I may as well shut down that
Slack now. There is nothing to see there now.
On 12/18/2019 1:34 PM, Abdelatif Guettouche wrote:
I'd prefer that the Getting Started guide should be reachable by one
click from the front page of the NuttX website (which doesn't exist
yet), so that a TOTAL newbie who hasn't even gotten the code yet can
read and get a feel for what's involved.
Agree.
I wanted to point out that much of the content needed to make such a
document is already in place.
Yes, much of the information is in the README file. Perhaps we can
modify text files like that to be in Markdown format, which unlike
HTML, leaves the file looking like a normal ASCII file, but allows the
file to be converted to other formats, including HTML, using automated
tools. Then we could convert that information and display it directly
on the website.
That would helpful.
Some of the readme files are already (almost) in Markdown format.
On Wed, Dec 18, 2019 at 5:46 PM Nathan Hartman <hartman.nat...@gmail.com> wrote:
On Wed, Dec 18, 2019 at 12:01 PM Gregory Nutt <spudan...@gmail.com> wrote:
There is this: http://www.nuttx.org/doku.php?id=wiki:getting-started
where the "external tutorials" is quite extensive:
http://www.nuttx.org/doku.php?id=wiki:getting-started:external-tutorials
That's great but I think we need our own basic Getting Started guide
that gets a total newbie off the ground quickly; it can, of course,
have an "Additional Resources" section with links to all of these
other resources.
On Wed, Dec 18, 2019 at 12:31 PM Abdelatif Guettouche
<abdelatif.guettou...@gmail.com> wrote:
Boards readme files contain all the information needed to get started
with a particular board.
Again, that's great, but it presumes that you have the code, know
about the board READMEs, know where they are...
I'd prefer that the Getting Started guide should be reachable by one
click from the front page of the NuttX website (which doesn't exist
yet), so that a TOTAL newbie who hasn't even gotten the code yet can
read and get a feel for what's involved.
Yes, much of the information is in the README file. Perhaps we can
modify text files like that to be in Markdown format, which unlike
HTML, leaves the file looking like a normal ASCII file, but allows the
file to be converted to other formats, including HTML, using automated
tools. Then we could convert that information and display it directly
on the website.
Nathan
