The book looks nice and I am looking forward to see it out
Best regards
Alin
-Original Message-
From: Gregory Nutt
Sent: den 15 maj 2023 01:44
To: dev@nuttx.apache.org
Subject: Re: The NuttX Handbook
> On 5/14/23, Brennan Ashton wrote:
>> Before I do more work to wir
https://www.amazon.com/MicroC-OS-II-Kernel-CD-ROM/dp/1578201039
Wow, never heard about that book but just looking at the ToC makes me
want to get one :-)
The original uC/OS I book published in 1992 was the one that really
established uC/OS and led to Micrium. I think that is this book:
h
On Mon, May 15, 2023 at 4:23 AM Brennan Ashton wrote:
> I suspect we need to get our documentation ducks in order before that
> outside help will be very useful. I agree that the aspiration should be
> something like the uC/OS II book which Greg mentioned,
> while dated at this point is very well w
>
> The first author that comes to mind, just off the top of my head, is Derek
> Molloy, the author of books like Exploring Raspberry Pi [1] and Exploring
> BeagleBone [2]. Both of these are about embedded systems. Both of these
> include tutorials not only in electronics (how to use FET transistor
On Sun, May 14, 2023 at 7:44 PM Gregory Nutt wrote:
>
> > On 5/14/23, Brennan Ashton wrote:
> >> Before I do more work to wire this up, please let me know if this pdf
> >> I have attached here seems like a reasonable start for people
> >> https://github.com/apache/nuttx/issues/9095#issuecomment-
Here goes the ePub format test build:
https://github.com/apache/nuttx/files/11473321/NuttX.epub.zip
I had to zip it for GH to accept the file, please unzip after download.
You can use your favorite e-book reader (even Kindle) or Calibre
desktop application to open it:
https://github.com/kovidgo
On Mon, May 15, 2023 at 1:44 AM Gregory Nutt wrote:
> Over the years, there have been several people with the dream of writing
> a commercial, NuttX book in the spirit of the famous uC/OS book. There
> were even a few starts but all gave up when the magnitude of the effort
> sunk in.
>
> But this
On 5/14/23, Brennan Ashton wrote:
Before I do more work to wire this up, please let me know if this pdf
I have attached here seems like a reasonable start for people
https://github.com/apache/nuttx/issues/9095#issuecomment-1547008998
It is basically the same content on the website, so missin
On 5/14/23, Brennan Ashton wrote:
sic
> Before I do more work to wire this up, please let me know if this pdf
> I have attached here seems like a reasonable start for people
> https://github.com/apache/nuttx/issues/9095#issuecomment-1547008998
>
> It is basically the same content on the website, s
On Sun, May 14, 2023 at 11:58 PM Brennan Ashton wrote:
> Before I do more work to wire this up, please let me know if this pdf
> I have attached here seems like a reasonable start for people
> https://github.com/apache/nuttx/issues/9095#issuecomment-1547008998
>
> It is basically the same content o
On Tue, Apr 25, 2023 at 8:46 AM Brennan Ashton
wrote:
>
>
>
> On Tue, Apr 25, 2023, 3:18 PM Gregory Nutt wrote:
>>
>>
>> > Thanks Alan! This is why I was a bit surprised why the documentation
>> > is not direct part of the source code (i.e. documentation of the
>> > file/module/function right in
On Tue, Apr 25, 2023 at 3:12 PM Brennan Ashton
wrote:
> On Tue, Apr 25, 2023, 7:45 PM Tomek CEDRO wrote:
>
> > On Tue, Apr 25, 2023 at 8:14 PM Gregory Nutt wrote:
> > > Tomasz Cedro now owns nuttx.com and nuttx.org.
> >
> > Yes the domains are for the project use, just let me know how you want
>
On Tue, Apr 25, 2023, 7:45 PM Tomek CEDRO wrote:
> On Tue, Apr 25, 2023 at 8:14 PM Gregory Nutt wrote:
> > Tomasz Cedro now owns nuttx.com and nuttx.org.
>
> Yes the domains are for the project use, just let me know how you want
> them configured, at this point they redirect to the main project s
On Tue, Apr 25, 2023 at 8:14 PM Gregory Nutt wrote:
> Tomasz Cedro now owns nuttx.com and nuttx.org.
Yes the domains are for the project use, just let me know how you want
them configured, at this point they redirect to the main project site
:-)
I was thinking about maybe some showcases of the pr
On Tue, Apr 25, 2023, 7:14 PM Gregory Nutt wrote:
> On 4/25/2023 11:38 AM, Nathan Hartman wrote:
>
> > I like the idea of keeping documentation in sync with the code(as much
> as
> > possible given our volunteer-based project).
>
> I wouldn't make a plan that depends on that. Engineers are not
On 4/25/2023 11:38 AM, Nathan Hartman wrote:
> I like the idea of keeping documentation in sync with the code(as much as
> possible given our volunteer-based project).
I wouldn't make a plan that depends on that. Engineers are notoriously
bad at maintaining documentation. And international pr
On Tue, Apr 25, 2023 at 7:38 PM Nathan Hartman wrote:
> On Tue, Apr 25, 2023 at 1:10 PM Tomek CEDRO wrote:
> > (..)
> > After some consideration a "safer" approach may be more desirable for now:
> >
> > 1. Migrate all documentation to a separate Documentation/ as it is
> > currently done, so we do
On Tue, Apr 25, 2023 at 7:26 PM Brennan Ashton wrote:
> Eh I don't think we should pull the docs apart. Its a pain to manage
> especially with sphinx if we start sprinkling the docs all over the place.
> it's also hard in my opinion to write clear cohesive docs thare do not get
> highly repetitive
On Tue, Apr 25, 2023 at 1:10 PM Tomek CEDRO wrote:
> On Tue, Apr 25, 2023 at 5:47 PM Brennan Ashton wrote:
> > On Tue, Apr 25, 2023, 3:18 PM Gregory Nutt wrote:
> > > My experience with using Deoxygen on large, projects has been
> > > disastrous. People don't always maintain the tags to the docu
On Tue, Apr 25, 2023 at 7:26 PM Brennan Ashton wrote:
> On Tue, Apr 25, 2023, 6:10 PM Tomek CEDRO wrote:
> (..)
> > After some consideration a "safer" approach may be more desirable for now:
> >
> > 1. Migrate all documentation to a separate Documentation/ as it is
> > currently done, so we do not
On Tue, Apr 25, 2023 at 9:59 AM Gregory Nutt wrote:
> Sorry, I know I am way to anal retentive:
> > In the past, documentation was partly in README files in various
> > directories in the repo, partly on the NuttX website which was running on
> > MediaWiki.
> It was actually DocuWiki and was the
On Tue, Apr 25, 2023, 6:10 PM Tomek CEDRO wrote:
> On Tue, Apr 25, 2023 at 5:47 PM Brennan Ashton wrote:
> > On Tue, Apr 25, 2023, 3:18 PM Gregory Nutt wrote:
> > > My experience with using Deoxygen on large, projects has been
> > > disastrous. People don't always maintain the tags to the docume
On Tue, Apr 25, 2023 at 5:47 PM Brennan Ashton wrote:
> On Tue, Apr 25, 2023, 3:18 PM Gregory Nutt wrote:
> > My experience with using Deoxygen on large, projects has been
> > disastrous. People don't always maintain the tags to the documentation
> > was wrong and so the auto-generated documentat
On Tue, Apr 25, 2023, 3:18 PM Gregory Nutt wrote:
>
> > Thanks Alan! This is why I was a bit surprised why the documentation
> > is not direct part of the source code (i.e. documentation of the
> > file/module/function right in that file/module/function). Kivy does
> > that, it helps understandin
not yet, we are busy preparing the Chinese documentation.
On Tue, Apr 25, 2023 at 10:27 PM Alan C. Assis wrote:
> On 4/25/23, Alan C. Assis wrote:
> > On 4/25/23, Gregory Nutt wrote:
> >>
> >>> Yes, using the Documentation/ as base to create a book is a good idea,
> >>> but it should focus on
On 4/25/23, Alan C. Assis wrote:
> On 4/25/23, Gregory Nutt wrote:
>>
>>> Yes, using the Documentation/ as base to create a book is a good idea,
>>> but it should focus on "OS Components" and "API Reference".
>>
>> I don't think that the documentation should be limited to simple HowTo
>> and What
On 4/25/23, Gregory Nutt wrote:
>
>> Yes, using the Documentation/ as base to create a book is a good idea,
>> but it should focus on "OS Components" and "API Reference".
>
> I don't think that the documentation should be limited to simple HowTo
> and WhatIs documentation. I think it should have
Thanks Alan! This is why I was a bit surprised why the documentation
is not direct part of the source code (i.e. documentation of the
file/module/function right in that file/module/function). Kivy does
that, it helps understanding the code, allows easy online/pdf
documentation out of it, and mo
Yes, using the Documentation/ as base to create a book is a good idea,
but it should focus on "OS Components" and "API Reference".
I don't think that the documentation should be limited to simple HowTo
and WhatIs documentation. I think it should have some technical meat
too! Like explanat
On Tue, Apr 25, 2023 at 3:59 PM Gregory Nutt wrote:
>
> Sorry, I know I am way to anal retentive:
> > In the past, documentation was partly in README files in various
> > directories in the repo, partly on the NuttX website which was running on
> > MediaWiki.
> It was actually DocuWiki and was the
On Tue, Apr 25, 2023 at 3:35 PM Alan C. Assis wrote:
> Hi Tomek,
>
> Some years ago Matias Nitsche (AKA v0id / protobits) started the
> creation of a NuttX book, documenting many of internal OS functions.
>
> But after some time he gave up, because he realized that NuttX is a
> movable target. Same
Sorry, I know I am way to anal retentive:
In the past, documentation was partly in README files in various
directories in the repo, partly on the NuttX website which was running on
MediaWiki.
It was actually DocuWiki and was the landing page for the old nuttx.org
website (not that it matters)
On Tue, Apr 25, 2023 at 3:01 PM Nathan Hartman wrote:
> On Tue, Apr 25, 2023 at 8:37 AM Tomek CEDRO wrote:
> > I would like to know what is the current and past approach to the
> > documentation, to plan the work and align the tasks (with other people
> > working on the documentation?). What is the
On 4/25/23, Brennan Ashton wrote:
>
> Others and I _extended_ and converted this to be what is now in
> Documentation it was a lot of work. This is the documentation for the
> project although it has been slow to convert all the readmes and the wiki
> to be here. I would love to see others help w
On Tue, Apr 25, 2023 at 2:55 PM Brennan Ashton wrote:
> (..)
> > It is easy enough to generate the PDF from the sphinx documentation if we
> > want that can you create an issue on the website project and I'll enable
> > that in a few weeks.
> Also I want to be very clear since this was incorrect
Hi Tomek,
Some years ago Matias Nitsche (AKA v0id / protobits) started the
creation of a NuttX book, documenting many of internal OS functions.
But after some time he gave up, because he realized that NuttX is a
movable target. Same happens to Linux (although currently I think
Linux is more stabl
On Tue, Apr 25, 2023 at 8:55 AM Brennan Ashton
wrote:
> On Tue, Apr 25, 2023, 1:46 PM Brennan Ashton
> wrote:
>
> >
> >
> > On Tue, Apr 25, 2023, 1:37 PM Tomek CEDRO wrote:
> >
> >> Hello world :-)
> >>
> >> I was on a trip recently (and it happens quite often) so I was looking
> >> for a PDF v
On Tue, Apr 25, 2023 at 8:37 AM Tomek CEDRO wrote:
> Hello world :-)
>
> I was on a trip recently (and it happens quite often) so I was looking
> for a PDF version of NuttX Documentation, kind of Handbook, but I did
> not find one.
>
> I got used to PDF Handbook style because it is all-in-one app
On Tue, Apr 25, 2023, 1:46 PM Brennan Ashton
wrote:
>
>
> On Tue, Apr 25, 2023, 1:37 PM Tomek CEDRO wrote:
>
>> Hello world :-)
>>
>> I was on a trip recently (and it happens quite often) so I was looking
>> for a PDF version of NuttX Documentation, kind of Handbook, but I did
>> not find one.
>
On Tue, Apr 25, 2023, 1:37 PM Tomek CEDRO wrote:
> Hello world :-)
>
> I was on a trip recently (and it happens quite often) so I was looking
> for a PDF version of NuttX Documentation, kind of Handbook, but I did
> not find one.
>
> I got used to PDF Handbook style because it is all-in-one appro
40 matches
Mail list logo
