Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

turn README into an mdbook #46

Merged
merged 1 commit into from
Aug 4, 2020
Merged

turn README into an mdbook #46

merged 1 commit into from
Aug 4, 2020

Conversation

japaric
Copy link
Member

@japaric japaric commented Aug 4, 2020 •
edited
Loading

Apart from splitting the README into smaller markdown files I have:

  • added docs for intern! and {:istr} (user/logging/istr section)
  • added clearer setup instructions for library vs app use (user/setup section
  • added info about how to build a 64-bit timestamp from 32-bit counters (user/timestamp section)

closes #10
closes #39

@japaric
Copy link
Member Author

japaric commented Aug 4, 2020

Preview: https://deploy-preview-46--flamboyant-mayer-c4bfd0.netlify.app/

jonas-schievink
jonas-schievink approved these changes Aug 4, 2020
View reviewed changes
Copy link
Contributor

@jonas-schievink jonas-schievink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

We should also run the contained code examples as tests, if possible.

@japaric
Copy link
Member Author

japaric commented Aug 4, 2020

We should also run the contained code examples as tests, if possible.

Good call. Will do that in a follow-up PR.

@japaric japaric merged commit aafedcb into main Aug 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jonas-schievink jonas-schievink jonas-schievink approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

move top-level README into mdbook add user documentation for intern!
2 participants
@japaric @jonas-schievink