Rearrange README, add internal navigation links

NorthernWidget / DS3231

Communicates between Arduino-programmed AVR and Maxim DS3231 RTC: splice of Ayars' (http://hacks.ayars.org/2011/04/ds3231-real-time-clock.html) and Jeelabs/Ladyada's (https://github.com/adafruit/RTClib) libraries

The Unlicense

183 stars 81 forks source link

Rearrange README, add internal navigation links #56

Closed IowaDave closed 2 years ago

IowaDave commented 2 years ago

Here is a proposed initial rewrite of the README file. Changes include:

rearrangement of existing content
interior links for organization and navigation
expand discussion of time.h and Wire.h
add references to the data sheet
add a To Do list

I see more work to do. Examples: documentation for each function; discussion of each Example sketch. That's for later, out of scope for a first draft.

Wanted to put this draft out there for initial thoughts and responses. Thanks!

David

jnuernberg commented 2 years ago

Hi @IowaDave,

This looks amazing, just two remarks:

I would relable the section "Links to Useful Information" into "Contents"
In addition, I would rearrange the sections in the readme in the same order as in the section "Links to useful information"/"Contents". I honestly prefer the order, that you have in there over the arrangment below in the readme.

Great work.

Best regards, Jacob

IowaDave commented 2 years ago

The changes to ordering and labeling make sense. I'll do it.

To be honest I've moved quite a ways farther down the road with the rewrite. I think I'll withdraw this PR, make the changes you suggest, and bring the recent work forward for consideration. Not sure how to withdraw a PR. Got to figure that step out first.

Thanks!

IowaDave commented 2 years ago

Changes made as requested to the working draft on my side. Closing this PR because premature and superseded by subsequent work. Planning to resubmit a PR with a more complete rewrite.