Update author list towards possible publication

[awickert]

After seeing all of the work that has gone into this library over more than a decade, including significant use by those in the Academy, I think that it might be worthwhile generating a short article on it to the Journal of Open Source Software.

@jnuernberg @IowaDave @hasenradball : I would like to be in contact with you about this, as the three biggest contributors. Google and I have guessed the identities of two of you, but @hasenradball , if you would like to be part of this, please share your name on the CITATION.cff. We'll bring in Eric Ayars as well, as the original developer of the library.

Looking forward to hearing of your interest in this project, and that this can help us (me, especially, finally) set aside real time to develop an even more solid & stable library.

And of course: sending good wishes for the holidays!

[IowaDave]

Thank you, I will look at this today. Forgive me, I have been away from the project for a while. There was some unpleasantness directed at me and I thought it best to step back rather than to engage with the behavior. I appreciate your attention to the repo recently. The request for a "release" looked like an owner's-level request that I felt reluctant to address. I will re-familiarize myself with the repo now in hopes that I may be able to contribute usefully again going forward. For example I can add clarification in the documentation regarding the treatment of the Century Bit. Thanks, and may Christmas be a time of happiness for your family and you. David

…

On Mon, Dec 22, 2025 at 9:09 AM Andy Wickert ***@***.***> wrote: Assigned #103 <#103> to @IowaDave <https://github.com/IowaDave>. — Reply to this email directly, view it on GitHub <#103 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AIOVVUGRICBDM2UXN6QSPTL4DAQV7AVCNFSM6AAAAACPYURYI2VHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMRRG4YDSMJSGM4DCNY> . You are receiving this because you were assigned.Message ID: ***@***.***>

[awickert]

Thanks @IowaDave.

I'm sorry that this became anything other than fun. Let's hope that things improve.

Yes, the "release" request, plus having a small bit more time, brought me back.

I will reopen the "Century" bit issue.

With good wishes for Christmastime as well!

[IowaDave]

Hello again. I looked into updating authoring information for the DS3231 repo on GitHub. It looked complicated and can even pose a risk to the commit history of the repo. It would help if I knew more of the ins and outs of git and of github; alas, it was never my primary topic of study. Admittedly, I probably was a bit obscure in the 'author' information included with previous PRs submitted to the repo. Thank you for pursuing the details. May I simply tell you? My name is David G. Sparks. I live in Waterloo, Iowa. Hence the username, IowaDave. Please include the middle initial, "G". I will do my best to submit my name in this form with any future PRs. I see there are some ToDos in addition to some open issues. Thanks, David

…

On Mon, Dec 22, 2025 at 9:44 AM Andy Wickert ***@***.***> wrote: *awickert* left a comment (NorthernWidget/DS3231#103) <#103 (comment)> Thanks @IowaDave <https://github.com/IowaDave>. I'm sorry that this became anything other than fun. Let's hope that things improve. Yes, the "release" request, plus having a small bit more time, brought me back. I will reopen the "Century" bit issue. With good wishes for Christmastime as well! — Reply to this email directly, view it on GitHub <#103 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AIOVVUEIE45FNMAMXV6GMXD4DAUWLAVCNFSM6AAAAACPYURYI2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTMOBTGEYTMNJVHE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[hasenradball]

Hello Andy thanks for your reply and the flowers...
What kind of article would that be?
Do you have already a proposal in mind?

Havibg a nice and quiet christmas time!

cheers
Frank

[jnuernberg]

Hi Andy,
Great to hear from you and I am very much positively surprised by the proposal. Like Frank, I am very much interested in hearing more about your plans.

I am currently traveling without access to a computer (writing from my phone just now). As soon as I am back home, I’ll review the .cff file and also add my Orcid.

Have a very merry Christmas, all of you,

Best regards, Jacob

[jnuernberg]

Hi Everyone,

I just created the branch issue/103-author-list and added my ORCID to the CFF file.

Additionally, I took the chance and look through the documentation: Amazing work @IowaDave, I have to say. I took the liberty to add a README.md file in both the /Documentation/ and /examples/ directories. As github renders markdown files named README.md directly, this allows to easily browse the documentation and examples on the github page. Check it out here.

I did not yet create a merge request, in case others would like to add changes on this issue, before merging.

Have a great start into the new year, and best regards from Switzerland,

Jacob

[hasenradball]

Hi guys,also added my nam to the cff file.About the Docu of the lib, what about to auto generate the Docu by doxygen after each push, merge etc…Have a good start in the new year….Mit freundlichen GrüßenFrank Häfelewww.esp8266-01-adapter.deAm 29.12.2025 um 20:30 schrieb Jacob ***@***.***>:jnuernberg left a comment (NorthernWidget/DS3231#103) Hi Everyone, I just created the branch issue/103-author-list and added my ORCID to the CFF file. Additionally, I took the chance and look through the documentation: Amazing work @IowaDave, I have to say. I took the liberty to add a README.md file in both the /Documentation/ and /examples/ directories. As github renders markdown files named README.md directly, this allows to easily browse the documentation and examples on the github page. Check it out here. I did not yet create a merge request, in case others would like to add changes on this issue, before merging. Have a great start into the new year, and best regards from Switzerland, Jacob —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: ***@***.***>

[awickert]

Hi @IowaDave , @hasenradball , and @jnuernberg ,

Thanks for your kind responses here and for your patience with me: was off doing other things during the holidays.

@IowaDave : This is, as the others show, just about updating the CITATION.cff file. I have you there already! There is no need to change commit history. (shudder)

The source of the proposal is that:

1. Many people use this library.
2. It could be nice to add some more attention to open-source electronics
3. It creates a good excuse to "get together" online and formalize / finalize our ideas about what this library should be.

JOSS, the journal, has a different than normal publication process. The entire process occurs in Markdown in a GitHub repository. The publication requirements are that the code is well documented and that it is reproducibly usable. Therefore, it gives extra testing and feedback without the overhead of a typical academic journal.

My timeline: I have a bunch of deadlines / etc. through January, so I'm thinking of moving this along in the background until Feb, when I'll have time to write the (short) manuscript and send it around to everyone to look at.

@hasenradball : You read my mind. I have used dOxygen in other projects to self-document functions, and have set up a small shell script to move the documentation into the README.md file. It does make the *.h file harder to read, so we can debate the merits there. See the Symbiont-LiDAR Library for a small working example.

@jnuernberg : I am writing from a tablet here, so I will follow your links once back at a real computer and follow up further if needed.

@IowaDave Happy new year!
@jnuernberg , @hasenradball : Ich hoffe, ihr feiert schon. Frohes neues!