Repository navigation
Expand README: overview, data sources, licence, layout and build notes - #13
Open
chrisdebian wants to merge 1 commit into
Open
chrisdebian wants to merge 1 commit into
chrisdebian wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Following up on #12, here's a first go at the README.
It keeps your existing intro and image, and adds:
maketargetsI also changed the documentation link from
httptohttps.Everything is taken from the makefiles, docs and folder contents, but please correct anything I've got wrong, especially the folder descriptions. Since
make helpprints the README, I kept it readable as plain text too.I checked that every link works and that
make helpreads cleanly. I didn't run a full build, since a README change doesn't touch it.As mentioned in #12, I used an AI assistant (Claude) to help read the code and draft this, and I've checked the content myself.