Documentation Fixes

[bryceschober]

So I know this project is "not ready for common usage", etc... but you have talked publicly about it, referenced it, documented it etc., so now I'm here. ;-)

I'm reading the docs to try to get a better understanding of the programming methods you're using, and seeing several small errors, which I'd have no problem submitting fixes for... except that it's written in M$ Word format, which is kinda hard to collaborate on via GitHub.

So I will volunteer to convert the docs to markdown as-is, if you think that would be an acceptable solution.

[wovo]

Hi Bryce The current documentation document was copied from a previous, somewhat similar, library. At this stage there is very little in it that reflects the current libary, so any work on it would mainly be wasted. I am not sure what a good format would be, but I'll try some markdown. At this point, the library has exactly one user (me), and a bunch of students that follow the development with interest. Are you interested in actually using the library? That would be helpful! If so, for what target(s), what kind of applications? Wouter van Ooijen 0638150444 - DL200 2.86

…

________________________________ From: Bryce Schober <notifications@github.com> Sent: Tuesday, January 9, 2018 8:30:39 PM To: wovo/hwcpp Cc: Subscribed Subject: [wovo/hwcpp] Documentation Fixes (#2) So I know this project is "not ready for common usage", etc... but you have talked publicly about it, referenced it, documented it etc., so now I'm here. ;-) I'm reading the docs to try to get a better understanding of the programming methods you're using, and seeing several small errors, which I'd have no problem submitting fixes for... except that it's written in M$ Word format, which is kinda hard to collaborate on via GitHub. So I will volunteer to convert the docs to markdown as-is, if you think that would be an acceptable solution. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub<#2>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AInubItwim4Qw7H0K4nwwEujxS1TIIrxks5tI75fgaJpZM4RYU7A>.

[bryceschober]

Well, you talked about it in public, and now I'm interested! At this point my interest is more experimental, but your work does directly relate to projects at my day job, and I'm interested both in learning more about your techniques, how I might use them myself, and the possibility of using your library in real product.

I do develop bare-metal applications on similar microcontrollers, which have historically been either all C (attempting to be as modular as possible) or elementary old-style C++. Your project is one of maybe two online (see kvasir) that are trying to apply modern C++ practice (as opposed to the traditional approach of C-language HAL with C++ wrappers) to bare-metal microcontroller applications, so it's very interesting in that regard.

[wovo]

I started writing hwcpp/docs/primer.md, it is w-i-p but if you have any comments let me know. I am very interested in my stuff being used for real, we should talk about this some more. I consider myslef a (very) experineced hobbyist and teacher, but my real industrial experience is from 15 years back, so I could use some real-world inputs! Are you by any change going to the Embo conference? Besides my work and Kvasir you might check xpcc at https://github.com/roboterclubaachen

…

________________________________ From: Bryce Schober <notifications@github.com> Sent: Wednesday, January 10, 2018 6:31:11 PM To: wovo/hwcpp Cc: Wouter van Ooijen; Comment Subject: Re: [wovo/hwcpp] Documentation Fixes (#2) Well, you talked about it in public, and now I'm interested! At this point my interest is more experimental, but your work does directly relate to projects at my day job, and I'm interested both in learning more about your techniques, how I might use them myself, and the possibility of using your library in real product. I do develop bare-metal applications on similar microcontrollers, which have historically been either all C (attempting to be as modular as possible) or elementary old-style C++. Your project is one of maybe two online (see kvasir<https://github.com/kvasir-io/Kvasir>) that are trying to apply modern C++ practice (as opposed to the traditional approach of C-language HAL with C++ wrappers) to bare-metal microcontroller applications, so it's very interesting in that regard. — You are receiving this because you commented. Reply to this email directly, view it on GitHub<#2 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AInubJE_-LUceogCG0bPCd6oeu9TZRkuks5tJPPfgaJpZM4RYU7A>.

[kaidokert]

Just FYI, in addition to Kvasir, there is a number of others, i've collected some over time here

https://github.com/kaidokert/embedded-cpp-code