8000 Improve `README.md` and add `CONTRIBUTING.md` by drewhoffer · Pull Request #178 · marcoroth/herb · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Improve README.md and add CONTRIBUTING.md #178

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
Merged
merged 4 commits into from
Jun 29, 2025
Merged

Improve README.md and add CONTRIBUTING.md #178

merged 4 commits into from
Jun 29, 2025

Conversation

drewhoffer
Copy link
Contributor
@drewhoffer drewhoffer commented Jun 27, 2025 •
edited
Loading
  • Try and give some more insight where possible
  • Show more steps around running the project
  • Still need to give more detail around the various packages and what they do
    • e.g. It would be nice to show newcomers something such as:
- **lib/** Ruby Bindings 
  - The ruby bindings are used as....
- **src/** Core C
  - The core c module provides x,y,z...
  • But honestly, i think based on discord discussions around POTENTIALLY moving the linter to C, we may be better off leaving that out until this repo becomes more stable/fleshed out.

@drewhoffer
docs(readme): Initial cut of README.
a43e0ca 
- Try and give some more insight where possible
- WIP still and need to learn more about the library to give proper insight
@drewhoffer drewhoffer marked this pull request as ready for review June 28, 2025 01:04
marcoroth
marcoroth reviewed Jun 28, 2025
View reviewed changes
Copy link
Owner
@marcoroth marcoroth 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 working on this @drewhoffer, while reading through I just had this thought that would make this README.md more manageable to navigate!

Let me know if you agree or think we should just keep everything in the README.md, thank you!

drewhoffer and others added 2 commits June 28, 2025 13:08
@drewhoffer
update readme to be much more trimmed down and move quickstart to CON… 8000
92299c4 
…TRIBUTING.md
@marcoroth
Update README.md
4bc304b 
Signed-off-by: Marco Roth <marco.roth@intergga.ch>
marcoroth
marcoroth approved these changes Jun 29, 2025
View reviewed changes
Copy link
Owner
@marcoroth marcoroth left a comment

Choose a reason for hiding this comment

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

Thank you so much, @drewhoffer! I filled in a bit for the README, but more than happy to tweak it again in a follow-up! Thanks

@marcoroth marcoroth changed the title docs(readme): Initial cut of README. Improve README.md and add CONTRIBUTING.md Jun 29, 2025
@marcoroth marcoroth merged commit 86a297b into marcoroth:main Jun 29, 2025
8 checks passed
@drewhoffer drewhoffer mentioned this pull request Jun 29, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
5422

@marcoroth marcoroth marcoroth 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.
2 participants
@drewhoffer @marcoroth
0