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

readme improvements #277

Merged
merged 1 commit into from
Jul 15, 2024
Merged

readme improvements #277

merged 1 commit into from
Jul 15, 2024

Conversation

eolesinski
Copy link
Contributor

This PR makes various improvements to the project's README.md

  • adds more detail to installation section
  • adds additional sections (documentation, etc.)
  • minor spelling fixes and phrasing changes

@eolesinski eolesinski force-pushed the readme-improvements branch from e1ce14f to 2f2d9c0 Compare July 7, 2024 21:23
@maurermi maurermi self-requested a review July 7, 2024 22:11
maurermi
maurermi requested changes Jul 7, 2024
View reviewed changes
Copy link
Collaborator

@maurermi maurermi left a comment

Choose a reason for hiding this comment

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

This looks good to me, but in general we try to not include binary files in this repo -- if you could convert the image from png format to svg that I think should make this good to go!

@eolesinski eolesinski force-pushed the readme-improvements branch 2 times, most recently from 3e0af75 to e4b73ba Compare July 7, 2024 23:20
@eolesinski eolesinski requested a review from maurermi July 7, 2024 23:23
@eolesinski eolesinski force-pushed the readme-improvements branch from e4b73ba to d62ba77 Compare July 8, 2024 14:33
maurermi
maurermi approved these changes Jul 8, 2024
View reviewed changes
Copy link
Collaborator

@maurermi maurermi left a comment

Choose a reason for hiding this comment

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

ACK, looks good on my end, a couple nit-picky comments that would be great to address IMO but I am comfortable with this as is

@eolesinski eolesinski force-pushed the readme-improvements branch 2 times, most recently from 45cb20e to b2c29b4 Compare July 9, 2024 19:57
HalosGhost
HalosGhost requested changes Jul 9, 2024
View reviewed changes
Copy link
Collaborator

@HalosGhost HalosGhost left a comment

Choose a reason for hiding this comment

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

I have a very few small requests to keep everything inline with current standards. None of it should be onerous.

@eolesinski
readme improvements
2fb7c7d 
Signed-off-by: eolesinski <[email protected]>
@eolesinski eolesinski force-pushed the readme-improvements branch from 04d3800 to 2fb7c7d Compare July 13, 2024 19:16
@eolesinski eolesinski requested a review from HalosGhost July 15, 2024 15:03
HalosGhost
HalosGhost approved these changes Jul 15, 2024
View reviewed changes
Copy link
Collaborator

@HalosGhost HalosGhost 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 handling all my little nits! This looks good to me. Will merge once CI finishes.

@HalosGhost HalosGhost merged commit d4ddb28 into mit-dci:trunk Jul 15, 2024
6 checks passed
@HalosGhost HalosGhost mentioned this pull request Jul 15, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@HalosGhost HalosGhost HalosGhost approved these changes

@maurermi maurermi maurermi 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.
3 participants
@eolesinski @HalosGhost @maurermi