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.

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

Readme updates #137

Merged
merged 6 commits into from
Jan 15, 2024
Merged

Readme updates #137

merged 6 commits into from
Jan 15, 2024

Conversation

hdholm
Copy link
Contributor

@hdholm hdholm commented Jan 11, 2024

Update README.md to account for recent llhttp build changes and the availability of packaged versions for FreeBSD.

Update README.md to account for recent llhttp build changes and the availability of packaged versions for FreeBSD.
Missed one llhttp
@codecov-commenter
Copy link

codecov-commenter commented Jan 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (761423d) 57.60% compared to head (26bab1a) 57.60%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #137   +/-   ##
=======================================
  Coverage   57.60%   57.60%           
=======================================
  Files           4        4           
  Lines         552      552           
  Branches      145      145           
=======================================
  Hits          318      318           
  Misses        133      133           
  Partials      101      101           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

A few more updates to reflect changes in more recent versions.
Fix cut and paste error
@hdholm
Copy link
Contributor Author

hdholm commented Jan 11, 2024

My original thinking had been to update the README to show llhttp as the required library. But, of course, the Debian-based distros don't have it and it looks like CentOS 7 and CentOS Stream 8 don't either. CentOS Stream 9 is being built with http-parser, although llhttp is available in EPEL 9. So, now I'm thinking maybe the README should be adjusted to be clearer that it works with both. I was just trying to make it reflect recent events; I don't have a preference if someone else changes it. I'm certainly also happy to make the adjustments to the PR if that's what's preferred.

Copy link
Collaborator

@sarroutbi sarroutbi left a comment

Choose a reason for hiding this comment

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

Thanks for your change. In general, it LGTM. Requesting some minimum changes to distinguish between distributions

Copy link
Collaborator

@sarroutbi sarroutbi left a comment

Choose a reason for hiding this comment

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

Thanks for your changes. As you commented, please, change to include both dependencies according to the kind of distribution. Something like this would be enough:

Tang requires a few other software libraries:

  • CentOS / Debian based distributions:
  1. https-parser >= 2.8.0
  2. systemd
  3. jose
  • Rest of distributions:
  1. llhttp - ...
  2. systemd
  3. jose

Noted that either http_parser or llhttp reequired.  Removed systemd from the required list, since strictly speaking it's not required for stand-alone operation.
@hdholm
Copy link
Contributor Author

hdholm commented Jan 12, 2024

Changed to note that either http_parser or llhttp reequired. Removed systemd from the required list, since strictly speaking it's not required for stand-alone operation.

@hdholm hdholm requested a review from sarroutbi January 12, 2024 16:11
Clean up the markup that went wrong.
Copy link
Collaborator

@sarroutbi sarroutbi left a comment

Choose a reason for hiding this comment

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

Changes LGTM

@sarroutbi sarroutbi merged commit df3cc46 into latchset:master Jan 15, 2024
1 check passed
@hdholm hdholm deleted the README-updates branch February 6, 2024 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants